Skip to content

Commit

Permalink
Docs: Add backend setup instructions, update test commands and add co…
Browse files Browse the repository at this point in the history
…ntributors
  • Loading branch information
SverreNystad committed Jan 3, 2024
1 parent a1f4b8d commit 0a23531
Showing 1 changed file with 35 additions and 9 deletions.
44 changes: 35 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ To setup the project, one needs to have all the prerequisites installed. Then on
git clone https://github.com/CogitoNTNU/TutorAI.git
cd TutorAI
```
## Setup the backend

### Virtual Environment (Recommended)

Expand Down Expand Up @@ -114,21 +115,46 @@ For secure and efficient management of environment-specific variables, TutorAI u


## Usage
To run the project, run the following command in the root directory of the project:
To run the project, run the following command in the `backend` directory of the project:
```bash
python main.py
python manage.py runserver
```

## Tests
To run all the tests, run the following command in the root directory of the project:
### Backend
To run all the tests, run the following command in the `backend` directory of the project:
```bash
pytest
```

If you do not want to run api tests, run the following command instead:
```bash
pytest -m "not apitest"
python manage.py test
```
### Frontend
There are currently no tests for the frontend.



## Contributors

<table align="center">
<tr>
<td align="center">
<a href="https://github.com/olavsl">
<img src="https://github.com/olavsl.png?size=100" width="100px;" alt="Olav Selnes Lorentzen"/><br />
<sub><b>Olav Selnes Lorentzen</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Knolaisen">
<img src="https://github.com/Knolaisen.png?size=100" width="100px;" alt="Kristoffer Nohr Olaisen"/><br />
<sub><b>Kristoffer Nohr Olaisen</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/SverreNystad">
<img src="https://github.com/SverreNystad.png?size=100" width="100px;"/><br />
<sub><b>Sverre Nystad</b></sub>
</a>
</td>
</tr>
</table>

## License
Licensed under the [MIT License](LICENSE). Because this is a template repository, you need to change the license if you want to use it for your own project.
Expand Down

0 comments on commit 0a23531

Please sign in to comment.