Expense Splitter is a modern web application that helps you track shared expenses and settle up with friends, roommates, or family members. Split bills, track who owes what, and manage group expenses with ease.
- 💰 Track shared expenses with friends or groups
- 👥 Create and manage multiple groups
- 📊 View spending analytics and reports
- 🔄 Settle up balances with friends
- 📱 Responsive design works on all devices
- 🔐 Secure authentication and data protection
- 📱 PWA support for mobile devices
- Node.js 18.0.0 or later
- npm or yarn
- PostgreSQL database
-
Clone the repository:
git clone https://github.com/yourusername/expense-splitter.git cd expense-splitter -
Install dependencies:
npm install # or yarn install -
Set up environment variables:
cp .env.example .env.local
Update the
.env.localfile with your database credentials and other settings. -
Run database migrations:
npx prisma migrate dev
-
Start the development server:
npm run dev # or yarn dev -
Open http://localhost:3000 in your browser to see the application.
- Next.js - The React Framework for Production
- TypeScript - Type-Safe JavaScript
- Tailwind CSS - A utility-first CSS framework
- Prisma - Next-generation ORM for Node.js & TypeScript
- NextAuth.js - Authentication for Next.js
- shadcn/ui - Beautifully designed components
For detailed documentation, please visit our documentation website or check the /docs directory.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Your Name - @your_twitter - your.email@example.com
Project Link: https://github.com/yourusername/expense-splitter