Update contribution guidelines (#403)

* Update contribution guidelines to include dependency installation

Now mentions the required system dependencies, and the step for installing Elixir deps
Erlang is used by the :gettext dependency, and ecto.create will fail if it is not present

* Make Clickhouse and PostgreSQL containers run in detached mode

This ensures that they run in the background so that they are present during the follow steps
pull/404/head
Johan Fagerberg 6 years ago committed by GitHub
parent 77ec529f19
commit 3ff2c79b33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -4,9 +4,12 @@
The easiest way to get up and running is to [install](https://docs.docker.com/get-docker/) and use Docker for running both Postgres and Clickhouse.
Make sure Docker, Elixir, Erlang and Node.js are all installed on your development machine.
### Start the environment:
1. Run both `make postgres` and `make clickhouse`.
2. Run `mix deps.get`. This will download the required Elixir dependencies.
2. Run `mix ecto.create`. This will create the required databases in both Postgres and Clickhouse.
3. Run `mix ecto.migrate` to build the database schema.
4. Run `npm ci --prefix assets` to install the required node dependencies.

@ -1,8 +1,8 @@
clickhouse:
docker run -p 8123:8123 --ulimit nofile=262144:262144 --volume=$$HOME/clickhouse_db_vol:/var/lib/clickhouse yandex/clickhouse-server
docker run --detach -p 8123:8123 --ulimit nofile=262144:262144 --volume=$$HOME/clickhouse_db_vol:/var/lib/clickhouse yandex/clickhouse-server
postgres:
docker run -e POSTGRES_PASSWORD="postgres" -p 5432:5432 postgres
docker run --detach -e POSTGRES_PASSWORD="postgres" -p 5432:5432 postgres
dummy_event:
curl 'http://localhost:8000/api/event' \

Loading…
Cancel
Save