To run the project, you need Python and pip
installed on your machine. Here are the steps to run the project:
- Clone the repository to your local machine.
- Create a virtual environment:
python -m venv venv
- Activate the virtual environment:
bash .\venv\Scripts\activate
- Install the required packages using
pip
:pip install -r requirements.txt
- Install
pre-commit
hooks:pre-commit install
- Run migrations using:
bash -python manage.py makemigrations - preps the database for migrations -python manage.py migrate - to migrate the database
- Start the development server using:
bash -python manage.py runserver
- The
pre-commit
hooks will automatically run before you commit any changes to ensure code quality and consistency. - If the
pre-commit
tests fail, they will automatically attempt to fix the issues. Afterpre-commit
has made updates, you should run:git add <modified-files> git commit -m "<original-commit-message>"
- If you need to manually run the
pre-commit
hooks, you can use:pre-commit run --all-files