Update README.md

This commit is contained in:
Michael 2025-04-02 13:04:09 +02:00
parent db1ac237c9
commit a920273f67

View file

@ -24,14 +24,17 @@ Currently only the dev version of the project is being developed, the branch to
Ensure docker is installed and its service is up and running Ensure docker is installed and its service is up and running
One can quickly test docker by running: docker run hello-world One can quickly test docker by running:
```
docker run hello-world
```
This repo contains a git submodule sintonia_webapp, it refers to this [repo](https://git.congegni.net/Congegni/sintonia_webapp). This repo contains a git submodule sintonia_webapp, it refers to this [repo](https://git.congegni.net/Congegni/sintonia_webapp).
To pull the repo, open a terminal in the root of this project and run this command: To pull the repo, open a terminal in the root of this project and run this command:
` ```
git submodule update --init --recursive --remote && cd sintonia_webapp && git checkout dev && cd .. git submodule update --init --recursive --remote && cd sintonia_webapp && git checkout dev && cd ..
` ```
The folder sintonia_webapp now it's synced with the dev branch (the currently active branch). The folder sintonia_webapp now it's synced with the dev branch (the currently active branch).
@ -42,9 +45,9 @@ Add a string to the api_key and secret_key field, for dev it can be any random s
Copy or rename the file .env.dev to .env Copy or rename the file .env.dev to .env
Run the following command: Run the following command:
` ```
docker compose -f docker-compose.yml -f docker-compose.override.yml build && docker compose up -d docker compose -f docker-compose.yml -f docker-compose.override.yml build && docker compose up -d
` ```
This commands builds the docker containers in dev mode, then il will attempt to start them up. This commands builds the docker containers in dev mode, then il will attempt to start them up.