diff --git a/README.md b/README.md index 64303567a..2febe954e 100644 --- a/README.md +++ b/README.md @@ -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 -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). 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 .. -` +``` 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 Run the following command: -` +``` 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.