openAnalyse is an open-source application that helps users to analyse how they are investing their time.

Live Website : https://openanalyse.netlify.app/

Frontend at https://github.com/Jaspreet-singh-1032/openAnalyse-frontend

STILL IN DEVELOPMENT, CONTRIBUTIONS ARE WELCOME

Setup

The first thing to do is to clone the repository:

git clone https://github.com/Jaspreet-singh-1032/open_analyse_backend.git

and cd into the project directory:

cd open_analyse_backend/

Then install the dependencies. Make sure to first create a virtual environment and run:

pip install -r requirements.txt

Migrate the database:

python manage.py migrate

Then run the server:

python manage.py runserver

The server will be running at http://127.0.0.1:8000/

Tests

To run the tests:

python manage.py test

To run the tests and view code coverage:

coverage run manage.py test && coverage report

Coding style

This project follows pep8 and django coding styles

Use flake8 to check for problems in this area.

Run:

flake8

Use pre-commit hooks to identify simple coding issues before committing code:

To setup pre-commit hooks run:

pre-commit install