Rigel Kent 8feb6627c5 (doc) update README.md and client package.json

- specify nodejs version
- clearer setup process
- cleanup of phoenix doc artifacts
- prioritize manual install

2018-12-11 18:39:23 +01:00

Mobilizon

Your federated organization and mobilization platform. Gather people with a convivial, ethical, and emancipating tool.

Development

Install dependencies:
- Elixir (and Erlang) by following the instructions at https://elixir-lang.github.io/install.html
- Fetch backend Elixir dependencies with mix deps.get.
- PostgreSQL
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 elixir and set elixir as the password.
- 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.

Now you can visit localhost:4000 from your browser and see the website (server and client) in action.

If you plan to specifically change the client side (frontend), do the following once the server is running:

Install the latest version of NodeJS
Change directory to js/ and do:
- Install JavaScript package dependencies: npm install.
- Run the developement server in watch mode: npm run dev. This will open a browser on localhost:8080 that gets automatically reloaded on change.

Just run docker-compose up -d to start a database container, an API container and the front-end dev container running on localhost.