Skip to content

Commit

Permalink
Docs: Add Docker setup instructions for backend
Browse files Browse the repository at this point in the history
  • Loading branch information
SverreNystad committed Jan 4, 2024
1 parent 9933415 commit 3eefa1f
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,27 @@ To setup the project, one needs to have all the prerequisites installed. Then on
### Prerequisites
- Ensure that git is installed on your machine. [Download Git](https://git-scm.com/downloads)
- Ensure Python 3.9 or newer is installed on your machine. [Download Python](https://www.python.org/downloads/)
- Familiarity with basic Python package management and virtual environments is beneficial.
- Docker is used for the backend and database setup. [Download Docker](https://www.docker.com/products/docker-desktop)

### Clone the repository
```bash
git clone https://github.com/CogitoNTNU/TutorAI.git
cd TutorAI
```
## Setup the backend
To setup the backend one can either automatically setup the backend using docker or manually setup the backend.

### Virtual Environment (Recommended)
### Docker
For ease of use and version management control, we use Docker to keep track of our containers and virtual environments.
```bash
cd backend
docker-compose build
docker-compose up
```

### Manual

#### Virtual Environment (Recommended)

<details>
<summary><strong>🚀 A better way to set up repositories </strong></summary>
Expand Down Expand Up @@ -83,7 +94,7 @@ A virtual environment in Python is a self-contained directory that contains a Py
```
</details>

### Install dependencies
#### Install dependencies
With the virtual environment activated, install the project dependencies:
```bash
pip install -r requirements.txt
Expand Down

0 comments on commit 3eefa1f

Please sign in to comment.