Welcome to gadget-x project, a backend api for an e-commerce application.
A REST api for an e-commerce website which enables secure in-app transactions and cross-platform shopping. This project is a node based project built with javascript programming language, mongodb (nosql database), and Redis (for caching). The technologies implemented include.
- nodejs
- mongodb
- redis
- cheerio
- passport js
- paystack
- Authentication: user login/register/forget-password implemented with jwt and google oauth2.0 with passport.js
- Authorization: Authorization for both admin product manager endpoints and customer user endpoints.
- product inventory management: CRUD (create, read, update, and delete) operations on products in inventory by an authorized product manager.
- In-app shopping: CRUD operations on items in cart and also a secure payment processing.
- crossplatform-shopping: this feature extends your search to products on jumia and makes it possible to navigate products from jumia on the application.
follow the following steps to contribute to this project.
- fork the repository by clicking the icon on the top right corner of the screen.
- contribute to project.
- node version 16.0 or above.
- redis-server
to get started with this project:
- visit https://nodejs.org/en/download to install latest version of nodejs on your computer
- visit https://redis.io/docs/install/install-redis/ for instructions on how to install redis-server on your OS
- run `npm install`
- setup environment variables
- run `sudo service redis-server start` to start redis-server.
- run `npm run Dev` to get started in development mode
reference the developer documentation for api usage.