Project Execution Portal

Installation

1. Install uv.
2. git clone <path-to-git-repo>
3. cd <path-to-git-repo>
4. uv venv
5. source .venv/bin/activate
6. uv sync
7. uv run pre-commit install
8. cp .env.example .env
9. export DJANGO_SETTINGS_MODULE=core.settings.local
10. uv run manage.py makemigrations
11. uv run manage.py migrate
12. uv run manage.py createsuperuser
13. uv run manage.py collectstatic
14. npm install
15. uv run manage.py dev

Unit Tests

Running uv run pytest will run all of the tests in your Django app named test.py, tests.py, test**.py, and tests**.py (see pyproject.toml for details).

To Use PostgreSQL

1. Install Docker.
2. Edit .env and uncomment the database configuration lines as documented in the file.
3. uv run manage.py start_db

To stop the database server run uv run manage.py stop_db. You can specify the local port the contaner is listening on by using the "--port" option, for example uv run manage.py start_db --port 9876 (make sure to update you .env file with the new port number). This can be helpful if you're working on multiple projects, each with their own PostgreSQL server.

To Use Redis

1. Install Docker.
2. Edit .env and uncomment the database configuration lines as documented in the file.
3. uv run manage.py start_redis

To stop the Redis server run uv run manage.py stop_redis. You can specify the local port the contaner is listening on by using the "--port" option, for example uv run manage.py start_redis --port 9876 (make sure to update you .env file with the new port number). This can be helpful if you're working on multiple projects, each with their own Redis server.