docs(server): Update docs with new docker compose steps (#7944)

* update setup

* add docker links
This commit is contained in:
Aarushi
2024-09-02 09:55:54 +01:00
committed by GitHub
parent cfa0b6610c
commit e4dc16a867

View File

@@ -56,6 +56,16 @@ Poetry is a package manager for Python. You can install it by running the follow
```bash
pip install poetry
```
- Installing Docker and Docker Compose
Docker containerizes applications, while Docker Compose orchestrates multi-container Docker applications.
You can follow the steps here:
If you need assistance installing docker:
https://docs.docker.com/desktop/
If you need assistance installing docker compose:
https://docs.docker.com/compose/install/
### Installing the dependencies
@@ -77,11 +87,13 @@ Once you have installed the dependencies, you can proceed to the next step.
### Setting up the database
In order to setup the database, you need to run the following command, in the same terminal you ran the `poetry install` command:
In order to setup the database, you need to run the following commands, in the same terminal you ran the `poetry install` command:
```bash
poetry run prisma migrate deploy
```
```sh
docker compose up postgres -d
poetry run prisma migrate dev --schema postgres/schema.prisma
docker compose down
```
After deploying the migration, to ensure that the database schema is correctly mapped to your codebase, allowing the application to interact with the database properly, you need to generate the Prisma database model:
```bash
@@ -92,10 +104,11 @@ Without running this command, the necessary Python modules (prisma.models) won't
### Running the server
To run the server, you can run the following command in the same terminal you ran the `poetry install` command:
To run the server, you can run the following commands in the same terminal you ran the `poetry install` command:
```bash
poetry run app
docker compose build
docker compose up
```
In the other terminal, you can run the following command to start the frontend: