saikatxshrey / store-api

Api made for furniture store with Node.js,Express.js,MongoDB,Mongoose

Store Api

Api made for furniture store with Node.js,Express.js,MongoDB & Mongoose

Demo

store.api.video.mp4

Screenshots

API Reference

Get all products

  GET /api/v1/products

Get all products (based on filtering)

  GET /api/v1/products?query=.......

Query

1) name

Query	Type	Description
name	string	fetch similar pattern name

2) featured

Query	Type	Description
featured	boolean	fetch featured/non-featured products

3) company

Query	Type	Description
company	string	fetch products from company-list(ikea/caressa/liddy/marcos)

4) sort

Query	Type	Description
sort	string	sort products on any basis (eg: name -> ascending order / -name -> descending oder)

5) fields

Query	Type	Description
fields	string	fetch selected fields of products (eg : name,price)

6) limit

Query	Type	Description
limit	integer	limit the fetch quantity of products

7) page

Query	Type	Description
page	integer	fetch according to page

8) numericFilters

Query	Type	Description
numericFilters	conditions	fetch according to conditions (>,>=,=,<,<=) [eg: price>=40,rating>4.5]

Get all products - testing

  GET /api/v1/products/static

Environment Variables

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

MONGO_URI = mongodb+srv://:@nodeexpressprojects.50qvu.mongodb.net/myFirstDatabase?retryWrites=true&w=majority

PORT = port no you want to run in

npm packages used

dependensies

express

  npm i express --save

mongoose

  npm i mongoose

dotenv

  npm i dotenv

dev-dependensies

nodemon

  npm i nodemon

Run On Local-Machine

To startup nodemon

  npm start

Manual start

  node app.js

Explicit port initialization

  PORT=<port-no> npm start

  PORT=<port-no> node app.js