From 0ee3196064a89c72e8148443cad6b49edec9adf0 Mon Sep 17 00:00:00 2001 From: Yannic Kilcher Date: Thu, 29 Dec 2022 00:38:12 +0100 Subject: [PATCH] added sleep instead of true containers in compose --- docker-compose.yaml | 8 ++++---- scripts/backend-development/README.md | 2 +- scripts/frontend-development/README.md | 2 +- website/README.md | 5 ++--- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docker-compose.yaml b/docker-compose.yaml index 014f44dc..473f9e89 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,14 +1,14 @@ version: "3.7" services: - # Use `docker compose up backend-dev` to start a database and work and the backend. + # Use `docker compose up backend-dev --build --attach-dependencies` to start a database and work and the backend. backend-dev: - image: tianon/true + image: sverrirab/sleep depends_on: [db, adminer] - # Use `docker compose up frontend-dev` to start all services needed to work on the frontend. + # Use `docker compose up frontend-dev --build --attach-dependencies` to start all services needed to work on the frontend. frontend-dev: - image: tianon/true + image: sverrirab/sleep depends_on: [db, webdb, adminer, maildev, backend] # This DB is for the FastAPI Backend. diff --git a/scripts/backend-development/README.md b/scripts/backend-development/README.md index 30be253e..ef2ac0bf 100644 --- a/scripts/backend-development/README.md +++ b/scripts/backend-development/README.md @@ -1,6 +1,6 @@ # Backend Development Setup -In root directory, run `docker compose up backend-dev` to start a database. The default settings are already configured to connect to the database at `localhost:5432`. +In root directory, run `docker compose up backend-dev --build --attach-dependencies` to start a database. The default settings are already configured to connect to the database at `localhost:5432`. Make sure you have all requirements installed. You can do this by running `pip install -r requirements.txt` inside the `backend` folder and `pip install -e .` inside the `oasst-shared` folder. Then, run the backend using the `run-local.sh` script. This will start the backend server at `http://localhost:8080`. diff --git a/scripts/frontend-development/README.md b/scripts/frontend-development/README.md index c0394694..05349fb9 100644 --- a/scripts/frontend-development/README.md +++ b/scripts/frontend-development/README.md @@ -1,5 +1,5 @@ # Frontend Development Setup -In root directory run `docker compose up frontend-dev --build` to start a database and the backend server. +In root directory run `docker compose up frontend-dev --build --attach-dependencies` to start a database and the backend server. Then, point your frontend at `http://localhost:8080` to start developing. During development, any API key will be accepted. diff --git a/website/README.md b/website/README.md index ab1a6f36..1c18ef7b 100644 --- a/website/README.md +++ b/website/README.md @@ -49,9 +49,8 @@ installed: If you're doing active development we suggest the following workflow: -1. In one tab, navigate to - `${OPEN_ASSISTANT_ROOT}/scripts/frontend-development`. -1. Run `docker compose up --build`. You can optionally include `-d` to detach and +1. In one tab, navigate to the project root. +1. Run `docker compose up frontend-dev --build --attach-dependencies`. You can optionally include `-d` to detach and later track the logs if desired. 1. In another tab navigate to `${OPEN_ASSISTANT_ROOT/website`. 1. Run `npm install`