zertz/bidou

Family budget

Manage your family budget

View Demo (not yet available) · Report Bug · Request Feature

About The Project

Bidou is a simple webapp to manage your family expenses and how much money each members deposit into the joint account.

Built With

Getting Started

Prerequisites

• pnpm

  npm install -g pnpm

• MongoDB - You can use Atlas MongoDB

Installation

1. Clone the repo

   git clone https://github.com/stivaugoin/bidou.git

2. Install NPM packages

   pnpm install

3. Create a .env based on .env.example and add your config

   // Your database connection (need to include database name)
   const DATABASE_URL = "";
   
   // Password used to enter in the app. There is no user account, only a password.
   const PASSWORD = "";

Usage

Start application

pnpm dev

Deploy on Vercel

You need to setup your environment before

Do not deploy main branch. Use latest version with tag instead.

vercel deploy --prod

Roadmap

• Rewrite application with NextJS and Mantine
• Add filters on list
• Add reports
• Responsive (mobile is not yet well supported)
• Remove Mantine and use a custom UI

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Steve Bourgoin - [email protected]

Project Link: https://github.com/stivaugoin/bidou