Official Frontend Link: Visit SplitBills GitHub Repository: View Repository
Official Backend Link: Visit SplitBills
GitHub Repository: View Repository
SplitBills is a powerful and responsive application designed to help friends, families, and groups manage and split expenses seamlessly. Whether it's a trip, a party, or everyday shared expenses, SplitEasy simplifies the process, ensuring everyone gets a fair share and no payment is left behind.
SplitBills is crafted with a range of features to make expense tracking and bill splitting both comprehensive and straightforward. Here’s what you can do:
-
User Registration & Authentication
- Securely register an account and log in to access personalized expense groups.
- Manage account details with robust authentication to keep data private and secure.
-
Create & Manage Groups
- Effortlessly create custom groups tailored to different types of expenses—whether it's a travel group, household expenses, or a project-based group.
- Easily add, edit, or delete groups as needed, providing full control over your groups.
-
Add, Edit, & Delete Expenses
- Record detailed expenses within each group, with fields for expense name, amount, and date.
- Update expense details as things change and remove unnecessary expenses to keep records clear.
-
Categorize Expenses & Groups
- Categorize each group and expense by type, making it easy to filter and organize spending.
- Categories help distinguish between types of expenses, giving insights into where the most money is spent.
-
Define Payment Modes
- Choose from multiple payment modes (cash, card, bank transfer, etc.) for each expense entry.
- This added detail helps track how payments are made and balances across different methods.
-
Split Expenses Automatically
- Automatic calculations divide expenses equally among group members or allow custom splitting ratios if contributions differ.
- A clear breakdown of each member’s share simplifies settlement.
-
Responsive Design for All Devices
- A fully responsive and beautiful frontend interface provides an exceptional user experience on mobile, tablet, and desktop screens.
- Enjoy a seamless experience across devices without any loss of functionality or clarity.
-
Interactive & Intuitive Interface
- A user-friendly interface that makes tracking expenses a breeze, with easy-to-use buttons, forms, and organized layouts.
- Quick access to core features and intuitive navigation for both beginners and advanced users.
Follow these steps to get the application up and running locally.
- Frontend: JavaScript, React, and Tailwind CSS
- Backend: Node.js, Express, MongoDB
-
Clone the Repository
git clone https://github.com/arnb-smnta/expense-split-prod-backend.git cd expense-split-prod-backend -
Install Backend Dependencies
npm install
-
Set Up Environment Variables
- Configure your environment variables as required given in the env.sample file in the repo(e.g., MongoDB URI, JWT secrets).
-
Run the Backend Server
npm start
The backend server should now be running at
http://localhost:8080. -
Frontend Setup
- Visit the official SplitBills frontend repository and follow similar steps to set up and run the frontend application.
- Frontend: React, Tailwind CSS, Redux (for state management)
- Backend: Node.js, Express.js, MongoDB, Mongoose (for database interactions)
- Authentication: JWT (JSON Web Tokens) for secure access control
- Deployment: Hosted on Netlify (Frontend) and suitable cloud service (Backend)
Add screenshots here to highlight the application's interface and major features.
For detailed API documentation and usage, check the API Documentation. Here’s a quick overview:
- User Endpoints: Register, login, manage account
- Group Endpoints: Create, update, delete groups
- Expense Endpoints: Add, edit, delete, categorize expenses
- Payment Endpoints: Specify payment modes, track balances
Contributions are welcome! Please check the contribution guidelines in the repository, and feel free to report any issues, request new features, or improve the codebase.
For feedback, bug reports, or to say hello, contact us. To know more about the frontend application visit splitbills-About
SplitBills - Making shared expenses simpler, fairer, and more manageable for everyone.