https://github.com/rohit1kumar/expense-sharing

Expense sharing API
https://github.com/rohit1kumar/expense-sharing

api-rest django-rest-framework expense-sharing

Last synced: 11 months ago
JSON representation

Expense sharing API

• Host: GitHub
• URL: https://github.com/rohit1kumar/expense-sharing
• Owner: rohit1kumar
• Created: 2024-10-21T15:35:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T07:19:22.000Z (over 1 year ago)
• Last Synced: 2025-03-15T21:27:10.029Z (over 1 year ago)
• Topics: api-rest, django-rest-framework, expense-sharing
• Language: Python
• Homepage: https://expense-sharing.onrender.com
• Size: 251 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Daily Expense Share API

## features

1. User Management

    - singup with email, name, mobile and password.

    - Retrieve profile details.

    - JWT based authentication with proper authorization.

2. Expense Management

    - Add expense with support for split methods: Equal, Exact, and Percentage

    - View individual and overall expense summaries.

    - Download balance sheet csv.

## Tech Stack

- Django Rest Framework

- PostgreSQL

## Database Design

![Database Design](docs/db_design.svg)

## Setup & Runing

1. Clone the repository `git clone https://github.com/rohit1kumar/expense-sharing.git`

2. Create a `.env` using `cp .env.example .env` and update the values.

3. Install dependencies using Poetry `poetry install` or `pip install -r requirements.txt`

4. Run the server using `python manage.py runserver`

5. (Optional) Run using Docker

```bash

docker-compose up --build

docker-compose exec web python manage.py makemigrations

docker-compose exec web python manage.py migrate

```

### [API Documentation](docs/api_docs.md)

[](https://app.getpostman.com/run-collection/20980024-01bfda48-3b9e-475e-937d-f01829d3b60f?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D20980024-01bfda48-3b9e-475e-937d-f01829d3b60f%26entityType%3Dcollection%26workspaceId%3Dfb130ba8-5a6b-4e2e-96df-3c87dd829d25)