mirror of https://github.com/plausible/analytics.git synced 2024-12-25 18:48:06 +03:00

chore(docker): improve repeat contributions workflow (#1057 )

* This change adds two new commands to gracefully stop and remove the Postgres and Clickhouse docker containers. To do so, it also gives them a recognizable name.

* Additionally, the Postgres container is updated to use a named volume for its data. This lower friction for repeat contributions where one would otherwise sign up and activate their accounts again and again each time.

2021-05-19 16:49:39 +03:00

1.5 KiB

Raw Blame History

Contributing

Development setup

The easiest way to get up and running is to install 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:

Run both make postgres and make clickhouse.
Run mix deps.get. This will download the required Elixir dependencies.
Run mix ecto.create. This will create the required databases in both Postgres and Clickhouse.
Run mix ecto.migrate to build the database schema.
Run npm ci --prefix assets to install the required node dependencies.
Run mix phx.server to start the Phoenix server.
The system is now available on localhost:8000.

Creating an account

Navigate to http://localhost:8000/register and fill in the form.
An e-mail won't actually be sent, but you can find the activation in the Phoenix logs in your terminal. Search for %Bamboo.Email{assigns: %{link: " and open the link listed.
Fill in the rest of the forms and for the domain use dummy.site
Run make dummy_event from the terminal to generate a fake pageview event for the dummy site.
You should now be all set!

Stopping Docker containers

Stop and remove the Postgres container with make postgres-stop.
Stop and remove the Clickhouse container with make clickhouse-stop.

Volumes are preserved. You'll find that the Postgres and Clickhouse state are retained when you bring them up again the next time: no need to re-register and so on.