tommy/mobilizon
1
0
Fork 0
forked from potsda.mn/mobilizon
Code Pull requests Activity

Improve documentation for the development section

Browse source 
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.
This commit is contained in:
Dany Marcoux 2019-11-06 23:42:06 +01:00
parent ddbe637c34
commit 80fe65ea93
No known key found for this signature in database
GPG key ID: 2E558BC282FA5A4A
1 changed files with 20 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
support/guides/development/development.md
View file

@ -1,10 +1,26 @@
# Development # Development
Clone the repo, and start the project through Docker. You'll need both Docker and Docker-Compose.
Clone the repository:
```bash ```bash
# With HTTPS
git clone https://framagit.org/framasoft/mobilizon && cd mobilizon 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: * Install dependencies:
* Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html) * 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. * 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 Now you can visit [`localhost:4000`](http://localhost:4000) in your browser
and see the website (server *and* client) in action. 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`.