Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (63 loc) · 5.33 KB

CONTRIBUTING.md

File metadata and controls

99 lines (63 loc) · 5.33 KB
Raw

Contributing

We welcome everyone to contribute to Plausible. This document is to help you on setting up your environment, finding a task, and opening pull requests.

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. The .tool-versions file is available to use with asdf or similar tools.

Start the environment

  1. Run both make postgres and make clickhouse.
  2. You can set up everything with make install (see Makefile), alternatively run each command separately:
    1. 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 mix download_country_database to fetch geolocation database
    5. Run npm --prefix assets install to install the required client-side dependencies.
    6. Run npm --prefix tracker install to install the required tracker dependencies.
    7. Run npm --prefix tracker run deploy to generate tracker files in priv/tracker/js
  3. Run make server or mix phx.server to start the Phoenix server.
  4. The system is now available on http://localhost:8000.

Seeds

You can optionally seed your database to automatically create an account and a site with stats:

  1. Run mix run priv/repo/seeds.exs to seed the database.
  2. Start the server with make server and navigate to http://localhost:8000/login.
  3. Log in with the following e-mail and password combination: user@plausible.test and plausible.
  4. You should now have a dummy.site site with generated stats.

Alternatively, you can manually create a new account:

  1. Navigate to http://localhost:8000/register and fill in the form.
  2. Fill in the rest of the forms and for the domain use dummy.site
  3. Skip the JS snippet and click start collecting data.
  4. Run mix send_pageview from the terminal to generate a fake pageview event for the dummy site.
  5. You should now be all set!

Stopping Docker containers

  1. Stop and remove the Postgres container with make postgres-stop.
  2. 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.

Note: Since we are deleting the containers, be careful when deleting volumes with docker volume prune. You might accidentally delete the database and would have to go through re-registration process.

Variants

This repository contains the code for the CE and the EE variants of Plausible. Both versions need to work for the changes to be accepted, so you may need to run both locally to check. To avoid repetition, the commands in this doc are given for the EE variant.

This section explains how to handle the CE variant. EE and CE use the same database servers but different databases, so they need to be seeded separately. When run, the two variants don't interfere with each other.

To run a command for the CE variant, set the env variable MIX_ENV to one of ce_dev or ce_test or ce, as appropriate for the command.

Examples

  • Setup: make install -> MIX_ENV=ce_dev make install
  • Seed data: mix run priv/repo/seeds.exs -> MIX_ENV=ce_dev mix run priv/repo/seeds.exs
  • Run server: make server -> MIX_ENV=ce_dev make server
  • Reset dev database: mix ecto.reset -> MIX_ENV=ce_dev mix ecto.reset
  • Run tests: mix test -> MIX_ENV=ce_test mix test
  • Compile: mix compile -> MIX_ENV=ce mix compile

Testing

End to end tests

  1. Run npm --prefix e2e install to install the required dependencies.
  2. Run npx --prefix e2e playwright install to install the browsers.
  3. Run mix test.e2e to run the tests, mix test.e2e --ui for more manual control over runs.

Backend unit tests

  • Run mix test.

Dashboard unit tests

  • Run npm --prefix assets test to run the tests.

Tracker end to end tests

  1. Run npx --prefix tracker playwright install to install the browsers.
  2. Run npm --prefix tracker test to run the tests, npm --prefix tracker test -- --ui for more manual control over runs.

Pre-commit hooks

pre-commit requires Python to be available locally and covers Elixir, JavaScript, and CSS. Set up with pip install --user pre-commit followed by pre-commit install. Conversely, if the prompts are far too bothersome, remove with pre-commit uninstall.

Finding a task

Bugs can be found in our issue tracker. Issues are usually up for grabs.

New features need to be discussed with the core team and the community first. If you're tackling a feature, please make sure it has been already discussed in the Discussions tab. We kindly ask contributors to use the discussion comment section to propose a solution before opening a pull request.

Pull requests without an associated issue or discussion may still be merged, but we will focus on changes that have already been talked through.