Skip to content

Commit

Permalink
Update Contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
pamella committed May 17, 2024
1 parent 39d0f2a commit e8fa44d
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,26 @@ How your tasks will be shown:

1. Clone the repository.

2. Install the dependencies.
2. Create a virtual environment.

3. Install the dependencies.

```bash
pip install -r requirements_test.txt
```

3. Run the tests. This packages uses `tox` to run tests on multiple evironments, please make sure they are passing before submitting a pull request.
4. Run the project. Relevant to check UI changes.

```bash
# Create the database and run the migrations.
python manage.py migrate
# Create a superuser. This will allow you to access the admin interface.
python manage.py createsuperuser
# Start the development server. You can view the application by navigating to the URL provided in the terminal.
python manage.py runserver
```

5. Run the tests. This package uses `tox` to run tests on multiple evironments, please make sure they are passing before submitting a pull request.

```bash
tox
Expand Down

0 comments on commit e8fa44d

Please sign in to comment.