Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 3.06 KB

README.md

File metadata and controls

74 lines (52 loc) · 3.06 KB
Raw

Bank For All - Peer Share and Microfinance Platform for All

This is an open-source project aimed at creating a peer sharing and microfinance platform for people who unemployed or low-income individuals or groups who otherwise would have no other access to financial services.

The platform will enable them to access loans, as well as share resources and knowledge with each other, thereby creating a sustainable community.

Features (Peer Share UI)

Designs for the Peer Share UI can be found here.

  • Sign Up Screen
  • Sign In Screen
  • Mobile Number Verification
  • Verification Code Screen
  • Account Created Screen
  • Touch ID Confirmation Screen
  • Set Pin Screen
  • Money Summary Screen
  • Dashboard Screen
  • Lending Peer Sharing Dashboard Screen
  • Peer Share Room (Member List) Screen
  • Peer Share Room (Pool) Screen
  • Peer Share Room (Biding) Screen
  • Peer Share Room (Payment) Screen
  • Peer Share Room (Receipt) Screen
  • Won Bids Screen

If any of you have an idea to share with us, please feel free to open a pull request.

Technologies Used

Installation

  • To install the project on your local machine, follow these steps:
  • Clone the repository using git clone https://github.com/<username>/<repository-name>.git.
  • Install the dependencies by running npm install in the root directory.
  • Start the client by running npm run dev.
  • Open your browser and navigate to http://localhost:3000.

Contributing

To contribute to the project, follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes and commit them to the new branch.
  4. Push the branch to your forked repository.
  5. Create a pull request to the main repository.

Contribution Guidelines

We welcome contributions from developers of all skill levels. Whether you're a seasoned developer or just starting out, there are many ways you can contribute to the project.

Reporting Issues

If you find a bug or issue with the platform, please report it by opening an issue on our GitHub repository. Be sure to include as much detail as possible, including steps to reproduce the issue.

Submitting Bug Fixes or Features

If you'd like to contribute code to the project, you can do so by submitting a pull request. Before submitting a pull request, please make sure to follow our coding standards and ensure that your changes are thoroughly tested.

Contributing to Documentation

We also welcome contributions to the project's documentation. If you notice any errors or omissions in the documentation, please submit a pull request with your proposed changes.

License

This project is licensed under the MIT License.