mirror
/
mobilizon
mirror of https://framagit.org/framasoft/mobilizon.git
1
0
Fork 0
Code Issues Releases Wiki Activity
mobilizon/docs/contribute/development.md

51 lines
2.2 KiB
Markdown
Raw Normal View History

Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
# Development
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.
2019-11-06 22:42:06 +00:00
Clone the repository:
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
```bash
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.
2019-11-06 22:42:06 +00:00
# With HTTPS
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
git clone https://framagit.org/framasoft/mobilizon && cd mobilizon
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.
2019-11-06 22:42:06 +00:00
# With SSH
git clone git@framagit.org:framasoft/mobilizon.git && cd mobilizon
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
```
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.
2019-11-06 22:42:06 +00:00
Run Mobilizon:
Move docs to mkdocs and improve them Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-11-17 17:11:33 +00:00
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.
2019-11-06 22:42:06 +00:00
* 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
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
* Install dependencies:
* Elixir (and Erlang) by following the instructions at [https://elixir-lang.github.io/install.html](https://elixir-lang.github.io/install.html)
* [PostgreSQL]() with PostGIS
Move docs to mkdocs and improve them Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-11-17 17:11:33 +00:00
* Install NodeJS (we guarantee support for the latest LTS and later) ![](https://img.shields.io/badge/node-%3E%3D%2012.0+-brightgreen.svg)
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
* Start services:
* Start postgres
* Setup services:
* Make sure the postgis extension is installed on your system.
* Create a postgres user with database creation capabilities, using the
following: `createuser -d -P mobilizon` and set `mobilizon` as the password.
Update docs and support Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-10-11 15:03:18 +00:00
* Install packages
* Fetch backend Elixir dependencies with `mix deps.get`.
* Go into the `cd js` directory, `yarn install` and then back `cd ../`
* Setup
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
* Create your database with `mix ecto.create`.
* Create the postgis extension on the database with a postgres user that has
superuser capabilities: `psql mobilizon_dev`
``` create extension if not exists postgis; ```
* Run migrations: `mix ecto.migrate`.
Update docs and support Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-10-11 15:03:18 +00:00
* Start Phoenix endpoint with `mix phx.server`. The client development server will also automatically be launched and will reload on file change.
Better docs Signed-off-by: Thomas Citharel <tcit@tcit.fr> Nicer docs No 3rd stage Add mix.deps get before docs Add :ex_doc on test env so that it runs into CI
2019-03-14 14:00:34 +00:00
Documentation proofing
2019-05-19 09:38:09 +00:00
Now you can visit [`localhost:4000`](http://localhost:4000) in your browser
Move docs to mkdocs and improve them Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-11-17 17:11:33 +00:00
and see the website (server *and* client) in action.