prosper20 / everything-gadget

E-commerce API

https://everything-gadget-production.up.railway.app/api/v1

0 stars 0 forks source link

readme

EverythingGadget API ⛳

fork repository

This is a repository for the API of Everything-Gadgets, an E-Commerce website, where you may purchase your preferred electronics products.

Tech Stack 🛠️

API Description

Click here for the current api documentaion on Postman.

Run locally

Fork this repo
Clone the project
```
  git clone your forked url
```
Install dependencies using
```
  npm install
```
Create a .env file in the root folder and set your environment variables
Run in either producton or development mode

for development mode
```
  npm run dev
```
for production mode
```
  npm run prod
```

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

PORT : port on which the server would run.
MONGO_URI: connection string for the mongodb database.
MONGO_USER : mongodb username.
MONGO_PASS : your mongodb password.
NODE_ENV : set to "development".
JWT_SECRET : secret for jwt token.
JWT_EXPIRES_IN : token duration eg "90d".