/bidou

Family budget

Primary LanguageTypeScriptMIT LicenseMIT


Logo

About The Project

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

CleanShot 2022-11-18 at 11 33 23@2x

Built With

Typescript Next React MongoDB Prisma Mantine

Getting Started

Prerequisites

  • pnpm
  • A MongoDB database - You can use Atlas MongoDB

Installation

  1. Install NPM packages
    pnpm install
  2. 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

License

MIT