From 80fe65ea93c282e04f3c2a781bf564a429e9d705 Mon Sep 17 00:00:00 2001 From: Dany Marcoux Date: Wed, 6 Nov 2019 23:42:06 +0100 Subject: [PATCH] Improve documentation for the development section Remove duplication for the Docker/Docker-Compose instructions. Mention that Docker/Docker-Compose is the recommended approach to run Mobilizon. Be clear about accessing `localhost:4000` only once the containers are fully built and launched. --- support/guides/development/development.md | 33 ++++++++++++++--------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/support/guides/development/development.md b/support/guides/development/development.md index 56a9cb14..e22a860c 100644 --- a/support/guides/development/development.md +++ b/support/guides/development/development.md @@ -1,10 +1,26 @@ # Development -Clone the repo, and start the project through Docker. You'll need both Docker and Docker-Compose. + +Clone the repository: ```bash +# With HTTPS git clone https://framagit.org/framasoft/mobilizon && cd mobilizon -make + +# With SSH +git clone git@framagit.org:framasoft/mobilizon.git && cd mobilizon ``` -## Manual + +Run Mobilizon: + * with Docker and Docker-Compose (**Recommended**) + * without Docker and Docker-Compose (This involves more work on your part, use Docker and Docker-Compose if you can) + +## With Docker and Docker-Compose + + * Install [Docker](https://docs.docker.com/install/#supported-platforms) and [Docker-Compose](https://docs.docker.com/compose/install/) for your system. + * Run `make start` to build, then launch a database container and an API container. + * Follow the progress of the build with `docker-compose logs -f`. + * Access `localhost:4000` in your browser once the containers are fully built and launched. + +## Without Docker and Docker-Compose * Install dependencies: * Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html) @@ -30,13 +46,4 @@ make * Start Phoenix endpoint with `mix phx.server`. The client development server will also automatically be launched and will reload on file change. Now you can visit [`localhost:4000`](http://localhost:4000) in your browser -and see the website (server *and* client) in action. - -## Docker -You need to install the latest supported [Docker](https://docs.docker.com/install/#supported-platforms) and [Docker-Compose](https://docs.docker.com/compose/install/) before using the Docker way of installing Mobilizon. - -Just run : -```bash -make start -``` -to build and launch a database container and an API container running on `localhost:4000`. +and see the website (server *and* client) in action. \ No newline at end of file