This is a distributed fintech system that provides various services, including authentication, account transactions, card management, and notifications. Nginx is used as the API gateway to handle incoming requests and provide routing and load balancing.
The system utilizes the following technologies:
- Auth-Service: Node.js, MongoDB and Mongoose are used for authentication-related functionalities.
- Account-Service: Node.js, MySQL and sequelizer are used for managing account transactions.
- Card-Service: Python-Flask, MySQL, Sqlalchemy and RQ are used for card management.
- Notification Service: Javascript, BullMQ, Mailgun, Twilio, and Redis are utilized for handling notifications and caching.
- Clone the repository:
git clone https://github.com/belovetech/Nairalink - Install the required dependencies for each service.
- Configure the necessary environment variables for each service.
- Set up the databases (MongoDB, MySQL, and Redis) and ensure they are running.
- Start each service by running the corresponding command.
The Auth-Service handles user authentication and authorization. It is built with Node.js and utilizes MongoDB for data storage. Follow the steps below to set up and run the Auth-Service:
- Install dependencies:
npm install - Configure environment variables, such as database connection details and authentication secrets.
- Start the service:
npm start:server
The Account-Service manages account transactions and balances. It is developed using Node.js and employs MySQL as the database. Follow these steps to set up and run the Account-Service:
- Install dependencies:
npm install - Configure environment variables, such as MySQL database connection details.
- Start the service:
npm start:server
The Card-Service handles card management operations. It is built with Python Flask and uses MySQL for data storage. Additionally, RQ (Redis Queue) is utilized for task management. Perform the following steps to set up and run the Card-Service:
- Install dependencies:
pip install -r requirements.txt - Configure environment variables, including MySQL and Redis connection details.
- Start the service:
python app.py
The Notification Service sends notifications to users via email and SMS. It is developed with Python, Flask, and BullMQ and utilizes Mailgun and Twilio for email and SMS functionality. Redis is used for caching. To set up and run the Notification Service, follow these steps:
- Install dependencies:
pip install -r requirements.txt - Configure environment variables, including Mailgun, Twilio, and Redis connection details.
- Start the service:
python app.py
Once all services are running, the API endpoints provided by the system are accessible through the Nginx API gateway. Refer to the API documentation for detailed information on available endpoints and their usage.
For interactive documentation of each service, you can use the following links:
- Auth-Service:
localhost:5000/api/v1/auth/docs - Account-Service:
localhost:3000/api/v1/account/docs - Card-Service:
localhost:8000/api/v1/account/docs - Notification Service:
localhost:8080/api-docs
These links will provide you with detailed information on the APIs and their respective functionalities for each service. Feel free to explore and interact with the documentation to understand how to use each service effectively.
We welcome contributions to enhance the functionality and stability of the distributed fintech system. Please follow the guidelines in the CONTRIBUTING.md file to contribute effectively.
This project is licensed under the MIT License.
visit Nairalink