nawafswe/paymentsystem

Simple payment system using nodejs

Payment API

Project overview:

A system that process a user payments monthly where each user allowed to have only one active payment in a month.

Server was developed following MVC design pattern and using Nodejs & Mongodb & Expressjs, all the code is properly documented using better practices following JSDocs

---

Project instructions:

• This project runs locally on your machine and it is dockerized project 🐳.
• Make sure you have installed nodejs and mongodb database before following the project instructions.
• Lastly make sure to create your own .env file to test the project

---

Commands to run the project:

1 - npm i to install all required dependencies.
2 - npm run start to run server in production mode.
3 - npm run dev to run server on development mode.
4 - npm run gen-doc to generate a static html documents can be viewed by visiting http://HOST:PORT/ on chrome to explorer the components of the project such as functions,variables,ect.