TujiFund App

TujiFund App is a powerful financial management platform designed specifically for cooperative groups (Chamas). It enables seamless tracking of individual contributions, dividend calculation, transaction management, and real-time updates, empowering members and administrators with greater control and visibility of their finances.

Features

User Authentication & Authorization: Secure sign-up, login, and role-based access for members and admins.

Contribution Tracking: Track individual member contributions, making it easier to monitor progress and ensure transparency.

Dividend Calculation & Distribution: Automated calculations and fair distribution of dividends based on contributions.

Real-time Updates: Stay updated with live data using WebSockets for an interactive user experience.

Financial Reports & Visualizations: Access comprehensive financial reports and interactive visualizations to understand the group's financial health.

Admin Dashboard: Manage group members, track activities, and oversee all transactions from a dedicated admin interface.

Getting Started

Follow these instructions to set up and run the TujiFund App locally on your machine.

Prerequisites

Before you begin, ensure the following software are installed:

• Go version 1.22.2 or higher (ServerSide)
• React.js (for frontend)
• SQLite3 (for database management)

Installation

Clone the repository:

git clone https://github.com/somulo1/TujiFund.git

Navigate to the project directory:

cd TujiFund

Install Go dependencies:

• Run the following command to install required Go packages:

  go mod tidy

• Install Node.js dependencies (if applicable):

• Set up SQLite3 database:

Create and configure your SQLite3 database file (if not already created). Update any necessary environment variables in .env or configuration files for database connection and other settings.

Run the application:

To start the application, run the following command:

go run backend/cmd/main.go

our application will be running locally at http://localhost:8080.

setting up the frontend

cd frontend

npm install

start the frontend

npm run dev

Contributing

We welcome contributions to improve TujiFund App. To contribute:

• Fork the repository.
• Create a new branch (git checkout -b feature-branch).
• Make your changes and commit (git commit -am 'Add new feature').
• Push to the branch (git push origin feature-branch).
• Open a pull request for review.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

Fred Gitonga FredMunene

Godwin Ouma oumaoumag

Samuel Omullo samuelomulo

Stephens Odhiambo steodhiambo

Hilary Omondi Hilary505