Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 3.08 KB

README.md

File metadata and controls

90 lines (62 loc) · 3.08 KB
Raw

INDEX

About this project

This is a fully functional e-commerce platform that will allow you to have a solid foundation as an initial project, even deploy it. The project uses JSON Web Token for session management, Google OAuth as an alternative for logging in, Stripe as the payment gateway. Feel free to collaborate/fork the project.

Development Environment Setup

To set up the development environment for this project, follow these steps:

  • Download Docker Desktop & Docker File (production only)

  • Or you can just install Node.js v16.20.1 (or a compatible version) on your system.

  • Clone the project repository using git clone https://github.com/yamilt351/api-rest.git

  • Install project dependencies using npm or yarn. Run npm install or yarn install in the project root directory.

  • Configure the environment variables required for the project.

MONGO=mongodb+srv://USERNAME:[email protected]/ecomerce?retryWrites=true&w=majority

JWT_TOKEN=z&&2DbCJa9d3gZkxFwJdE$&hHbRe47KHxAF%&N#qRVx*zVFG$W

PORT=3000

STRIPE_TOKEN=sk_text_YourStripeToken


SECRET:your_google_oauth_secret

CLIENTID:your_google_oauth_cliendId
  • Start the application using npm run dev or yarn run dev to launch the application.
  • Access the application in a web browser using the provided URL or port number.

Available Endpoints

Postman Documentation

Tests

npm run test

Live demo & Product Explanation.

Demo This a simple demo. Shoping Cart State is hanlde by the frontend, so you can store the shoping cart items init and still keep it even if the user is not loged into the app. This guarantee an excelent user experience btw, bc the user can explore your site before making orders. The backend provide pagination for some routes, for more info check the Documentation

Contribution.

  • Read The Documentation
  • Fork The Project
  • Make Atomic Changes , keep them small keep them easy
  • You have to provide Evidences in your PRs (Postman requests,covering much edge cases as you can)
  • Make git pull before create your PR

Licence

The Project is under GPL Licence