Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 2.6 KB

README.md

File metadata and controls

115 lines (81 loc) · 2.6 KB

Logo

For more information: group-fund-manager.vercel.app

MIT License build succeeded Test passing

Group Fund Manager

Allows administrators to keep and track financial records for small groups.

How It Works

  1. Don’t have a group? Add it.

  2. Add Member to your group.

  3. Add Transaction for a Member.

Get Started

  1. Login
  2. Reset Password

How to add a Group

  1. Click Groups on the Menu at the left
  2. The details you can provide about a new Group are:-
    • Photo (optional)
    • Group name
    • Purpose
  3. Click Save Group

How to add a Member

  1. Click Members on the Menu at the left
  2. The details you can provide about a new Member are:-
    • Photo (optional)
    • Phone number
    • First Name
    • Last Name
    • Gender
    • Group
    • Password
    • Confirm Password
    • Role
  3. Click Save Member

How To View Existing Members

  1. Click Members on the Menu
  2. Members appear in the list at the right of the side of Add Member form.

How to add a Transaction

  1. Click Transactions on the Menu at the left

  2. See a Transaction form at the right of the menu.

  3. Provide necessary details about the Transaction in the form. The details you can provide:-

    • Amount
    • Date
    • Charges
    • category
    • Group
    • Cause
    • Member
    • Loan Application

How To Contribute

  1. Fork this project.

  2. Clone this project.

  3. Open the terminal at the project root directory:-

  4. Run the following commands

    1. yarn add or npm install
    2. yarn start or npm start

  5. Test your code.

  6. Commit your changes.

  7. Push to your repo.

  8. Send us a Pull Request (PR).

  9. Wait for PR review.

  10. After Approve your contribution will go live.

  11. If not approved you will get response.

More contributions

  1. Use the app and share feedback.
  2. Open an issue.
  3. Suggest features.
  4. Tell your friends about the app.
  5. Give us a Star.

Why should you Contribute?

  1. Improves your coding skills.
  2. Connect with people of likemind.
  3. Build public atifacts that help you grow a reputation and career.
  4. Increase your Github commits.
  5. Add your voice to Open Source.
  6. To motivate the developers.

Tech Stack

The following are the technologies used to develop this project.

Frontend: ReactJS, TailwindCSS

Backend as a Service: Supabase

Hosting: Vercel.com