Bill Sharing App

A simple project that allows friends share bills together.

For Context: A user can # and create a group by adding others through their emails. Users can check what groups they are part of and donate money towards the group's money goals.

Relevant Badges

🚀 Quick start

1. Have Git and Node.js installed on your computer.
2. Clone the repo.
3. cd into the project and cd into both backend and frontend folders to install the dependencies using npm install.
4. In the backend folder, remember to migrate and seed important files using npm run migrate and npm run seed.
5. Create a .env file in the backend folder and add the necessary variables following the .env.sample format.
6. Run npm run start:dev to start the backend server.
7. Run yarn start to power the frontend.
8. Run npm run test to run tests for the backend server

❤️ Hosted Links

For backend using Heroku - https://bsa-backend.herokuapp.com/ For frontend using Netlify - https://bsa-fibre.netlify.app/

⭐ Technologies Used

1. JavaScript & Node.js & Expressjs
2. React with Ant design, Material UI
3. Postgres
4. ElephantSQL
5. Netlify
6. Heroku
7. Travis CI
8. Code Climate
9. Open Peeps

☀️ Sample .env file format

SECRET=
DEV_DATABASE_URL = postgres://<pg-user>:<pg-pass>@localhost:5432/<pg-database>
TEST_DATABASE_URL = postgres://<pg-user>:<pg-pass>@localhost:5432/<pg-database>

Available Backend APIs

1. To #:

POST localhost:3000/api/v1/auth/user

    {
        "email": "funmi@google.com",
        "password": "fff.H7",
        "firstName": "Funmilayo",
        "lastName": "Olaiya"
    }

2. To #:

POST localhost:3000/api/v1/auth/signin

    {
        "email": "funmi@google.com",
        "password": "fff.H7"
    }

3. To get account:

GET localhost:3000/api/v1/account Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

4. To update your account:

PATCH localhost:3000/api/v1/account

    {
        "firstName": "Funmilayto",
        "lastName": "Olaiya",
        "currency": "USD"
    }

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

5. To add money to personal balance:

PATCH localhost:3000/api/v1/add-money

    {
        "balance": 0  // get the present balance you have
        "amount": 5000.00,
    }

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

6. You can always create a group:

Note: if you are creating a group, make sure to add your email too.

POST localhost:3000/api/v1/create-group

    {
        "emails": ["dele@google.co", "feyi@gmail.co", "ufuoma@gmail.com"],
        "category": "Functions",
        "name": "Money Movers",
        "description": "Let us donate to give Bayo a brand new car.",
        "goalBalance": 500.00, // the exact money you wish to accumulate
    }

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

7. You can update a group:

PATCH localhost:3000/api/v1/group/:id

    {
        "emails": ["dele@google.co", "feyi@gmail.co", "ufuoma@gmail.com"],
        "category": "Functions",
        "name": "Money Movers",
        "description": "Let us donate to give Bayo a brand new car.",
        "goalBalance": 1000.00, // the exact money you wish to accumulate
    }

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

8. You can get a group:

GET localhost:3000/api/v1/group/:id

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

9. You can get all groups:

GET localhost:3000/api/v1/groups

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

10. You can get all groups:

GET localhost:3000/api/v1/groups

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

11. You can get all groups you are currently part of:

GET localhost:3000/api/v1/group?email=

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

12. You can deposit money towards the goals in a group:

PATCH localhost:3000/api/v1/group/add-money/:id

    {
        "balance": 4600.00,
        "goalBalance": 2000.00,
        "groupBalance": 700.00,
        "amount": 400.00
    }

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

13. You can delete a group:

DELETE localhost:3000/api/v1/group/:id

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

14. You can get transaction history/logs:

GET localhost:3000/api/v1/history

Note: copy the token gotten from the #/in response and add it to the Bearer token field in postman.

Available Frontend APIs

1. To #: localhost:8080/api/v1/sign-up
2. To #: localhost:8080/api/v1/sign-in
3. To view a user dashboard after signing up/in: localhost:8080/api/v1/dashboard
4. For user to make simple settings: localhost:8080/api/v1/settings
5. For user to check all groups they have created: localhost:8080/api/v1/groups
6. For user to check all groups they have been added to/part of: localhost:8080/api/v1/groups/:email
7. For user to get just one group: localhost:8080/api/v1/one-group/:id
8. For user to deposit money to personal account: localhost:8080/api/v1/add-money/:id
9. For user to deposit money to group: localhost:8080/api/v1/group-money/:id
10. For user to get transaction logs: localhost:8080/api/v1/history