mobilizon.chapril.org-mobil.../support/guides/development/development.md
Thomas Citharel 4938f853d5
Improve docs a bit
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2019-10-16 11:20:30 +02:00

1.9 KiB

Development

Clone the repo, and start the project through Docker. You'll need both Docker and Docker-Compose.

git clone https://framagit.org/framasoft/mobilizon && cd mobilizon
make

Manual

  • Install dependencies:
  • 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.
  • Install packages
    • Fetch backend Elixir dependencies with mix deps.get.
    • Go into the cd js directory, yarn install and then back cd ../
  • Setup
    • 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.

  • 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 in your browser and see the website (server and client) in action.

Docker

You need to install the latest supported Docker and Docker-Compose before using the Docker way of installing Mobilizon.

Just run :

make start

to build and launch a database container and an API container running on localhost:4000.