SplitCrew Overview

Welcome to SplitCrew, an app designed to simplify and streamline the process of splitting expenses among friends, family, or colleagues.

Database Schema

Features

Core Features

1. User Authentication and Registration:
   • Secure user registration and authentication processes.
   • Email verification and password reset.
2. Expense Management:
   • Allow users to add shared expenses.
   • Provide a list of all expenses.
3. Expense Summary and Participant Breakdown:
   • Generate a dashboard with a summary of all expenses.
   • Provide a detailed breakdown of expenses by participant.
4. Settlement:
   • Enable users to settle expenses, indicating the payment method used.
   • Automatically calculate the net balance for each participant.
5. Currency Support:
   • Allow users to select the currency for each expense entry.
6. Notification and Reminders:
   • Send push notifications for new expenses and pending settlements.
   • Send reminders for overdue settlements.
7. User Feedback:
   • Collect user feedback through the app.

Additional Features (Post-MVP)

8. Group Expenses:
   • Create and manage expenses for specific groups of participants.
9. Expense Comments:
   • Leave comments on specific expenses for communication.
10. Advanced Reporting:
    • Generate reports with detailed expense analytics.
11. Integration with Payment Platforms:
    • Integrate with popular payment platforms (e.g., PayPal, Venmo).
12. Split Equally Option:
    • Choose an option to split an expense equally among selected participants.
13. Receipt Scanning:
    • Scan and attach receipts to expense entries.

API Documentation

Postman

Explore the API endpoints and test requests using the Postman documentation by accessing the docs here

Endpoints

POST /api/v1/auth/register: Register a new user account.
POST /api/v1/auth/login: Authenticate user login.
POST /api/v1/expenses: Create a new expense entry.
GET /api/v1/expenses: Retrieve all expenses.
GET /api/v1/expenses/expense-summary: Retrieve expense summaries and participant breakdown.
POST /api/v1/expenses/settle-expense: Mark an expense as settled.
GET /api/v1/currencies: Retrieve supported currencies. ... and more.

For detailed API documentation, visit Postman API Documentation.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js
• npm
• PostgreSQL

Installation

1. Clone the repository:

   git clone https://github.com/sudodeo/splitcrew-API.git

2. Install dependencies:

   cd splitcrew-API
   npm install

3. Create .env file and set environment variables using .env.example as a template

4. Set up the PostgreSQL database and update the configuration in config/database.js.

5. Start the server:

   npm start

License

This project is licensed under the terms of the MIT license.