SplitWiseCalc is a Django REST API project designed to manage expenses and shared expenses among users. It allows users to create expenses, share them with others, view their wallet balances, and perform various administrative tasks. The project includes authentication and authorization mechanisms to ensure secure access to the API endpoints.
-
Clone the repository:
git clone <repository-url>
-
Navigate to the project directory:
cd SplitWiseCalc -
Create a virtual environment:
python -m venv venv
-
Activate the virtual environment:
-
On Windows:
venv\Scripts\activate
-
On macOS and Linux:
source venv/bin/activate
-
-
Install dependencies:
pip install -r requirements.txt
-
Apply migrations:
python manage.py migrate
-
Run the development server:
python manage.py runserver
-
Access the Swagger documentation:
-
Access the ReDoc documentation:
/api/create_user/: Create a new user./api/login_user/: Login user and generate access token./api/expenses/: Create, list, or retrieve a specific expense./api/expenses/share/: Share an expense with other users./api/wallet/balance/: Check wallet balance for the authenticated user./admin/expenses/: Admin view to list all expenses./admin/user_wallets/: Admin view to list user wallets and balances.
- Django: Web framework for building APIs.
- Django REST Framework: Toolkit for building Web APIs.
- drf-yasg: Library for generating Swagger/OpenAPI documentation.
- PyJWT: JSON Web Token implementation for Python.
- Django-filter: Filtering support for Django REST framework.