hansderly / sabotay-backend-api

Sabotay is a user-centric financial application designed to facilitate group-based savings and financial collaboration. As the organizer, you have the ability to create groups, set contribution amounts and durations, and add users to specific groups. Participants contribute funds to these groups on a regular basis. At the end of each cycle..

Group Savings Manager

The Group Savings Manager is a web-based application designed to facilitate collaborative saving among groups of users. This application allows you to create, manage, and track savings groups, making it easy for participants to contribute regularly and distribute funds at the end of each cycle.

Table of Contents

• Features
• Technologies Used
• Installation
• Usage
• Contributing
• License
• Contact

Features

• Group Management: Create and manage savings groups with customizable settings, including contribution amounts and cycle durations.

• Member Management: Invite users to join groups, track members, and their roles (e.g., Admin or Member).

• Contributions: Enable group members to make regular contributions to their groups, with the ability to specify the contributor.

• Cycle Management: Automatically manage savings cycles, ensuring equitable distribution of funds at the end of each cycle.

• Authentication & Security: Secure user authentication and data protection to maintain the integrity of your users' financial data.

  Working on

• Front-end: I am working on a NextJS dashboard to consume the API

Technologies Used

• Express.js: Express is used to develop the RESTful API endpoints for the application.

• JSON Web Tokens (JWT): JWTs are utilized for secure user authentication and authorization.

• Front-End Framework: Depending on your project, you may use a front-end framework like React, Angular, or Vue.js.

• Other Relevant Libraries & Tools: Prisma, brcypt

Installation

1. Clone this repository to your local machine.

 https://github.com/hansderly/sabotay-backend-api.git

2. Install the required dependencies.

yarn add

Usage

1. Configure the variable environement in .env file
2. Start the server.
3. Access the application in your browser at http://localhost:4000 (or the configured port).

Contributing

Contributions are welcome! If you have improvements, new features, or bug fixes to contribute, please submit a pull request. Ensure your code follows best practices and is well-documented.

License

This project is licensed under the MIT License.

Contact

If you have any questions or inquiries, please feel free to contact me at [e-mail].