Skip to content

akeren/restful-shop

Repository files navigation

Shop-API Application

Node JS is an open-source, cross-platform, JavaScript runtime environment that executes JavaScript code outside of a browser - (Wikipedia) Read more with an exmaple

Endpoints

Methods Endpoints Description Access
POST /users/signup Create an account Public
POST /users/login Login Private
POST /users/{id} Delete account Private
POST /products Create product Private
GET /products Get all products Public
PATCH /products/{id} Update a product Private
DELETE /products/{id} Delete a product Private
GET /products/{id} Get a product Public
POST /orders Create order Private
GET /orders Get all orders Private
PATCH /orders/{id} Update an order Private
DELETE /orders/{id} Delete an order Private
GET /orders/{id} Get an order Private

Server Requirement

NODE JS version ^8.16.2; so, if you have been using Node JS version less than that, kindly upgrade before using the project.

Contributing

Feel free to fork the repository and send pull request or reach out easily to me via twitter => Kater Akeren

Security Vulnerabilities

If you discover a security vulnerability within the project, please create an issue. All security vulnerabilities will be promptly addressed and appreciated.

Aknowledgement

I greatly acknowledge and appreciate the immense contribution of my mentor Maximilian Schwarzmüller.

License

Open-source Learning curve for beginers, intermediate, and senior developers. This project work is built and used with GPL.3.0 licence. You are free to integrate the codes to your application to build optimal, sustainable and help many seasoned young and upcoming developers to write optimal codes and built real-world applications with Node.JS & MongoDB.