SubhradeepSS / Bill-Tracker

A bill tracker built with react, djangorestframework and antd.

Bill-Tracker

A simple Bill Tracker built using DRF and React

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

A Bill Tracker site, where a user can add/update/delete his/her bills. The project is an example of a simple full-stack web-app built using Django REST Framework as backend framework and React as frontend framework.

Built With

Frameworks used in the project:

• Django
• Django REST Framework
• React
• Ant Design

Getting Started

To setup the project locally, follow the given steps

Prerequisites

Following software need to be installed in the system:

• git
• python
• pip
• virtual environment
• github-cli (optional)
• node

Installation

1. Clone the repo by

   git clone https://github.com/SubhradeepSS/Bill-Tracker.git

   or (if github-cli is installed)

   gh repo clone SubhradeepSS/Bill-Tracker

2. Open the project in any source code editor.
3. Navigate to the backend folder.
4. Activate python virtual environment. (see here for reference)
5. Inside the virtual environment, run

   pip install -r requirements.txt

6. Navigate to the frontend folder and run the following command in cli

   npm install

Usage

1. For activating backend, navigate to the backend directory and run the following commands:

    python manage.py makemigrations
    python manage.py migrate
    python manage.py runserver

2. For running the frontend, navigate to the frontend folder and run:

   npm start

3. Open http://localhost:3000/ if already not opened.

The site consists of a single page where the already added bills are shown and a form is there for the user to add a new bill or update an exisiting bill(using bill_no).