Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (77 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

124 lines (77 loc) · 3.92 KB
Raw

Contributing Guide

Building from source

This project uses

Make sure to install them before proceeding and that your docker daemon is running.

Version Requirements

  • Postgres >= 12
  • Rust >= 1.74
  • Node >= 22
  • pnpm >= 11
  • protoc >= 3.17
  • Docker >= 27

Install the dependencies and build

  • cargo build -p meteroid

  • if you need the metering api : cargo build -p metering

  • pnpm install --prefix modules/web

  • Copy the .env.example file to .env.

Run Meteroid (WITHOUT Metering)

Metering requires quite a lot of resources (clickhouse + kafka), so if you don't need it, you can run without it.

  • Start the database with : docker compose -f docker/develop/docker-compose.yml --env-file .env up.

    docker compose -f docker/develop/docker-compose.yml --env-file .env --profile metering up

  • Start the Rust backend cargo run -p meteroid --bin standalone.

    Or if you need Metering: cargo run -p meteroid --bin standalone --features="metering-server

  • Start the Web frontend pnpm --prefix modules/web/web-app run dev

You can now access the app at http://localhost:5173

Run Meteroid (WITH Metering)

  • Start the database with : docker compose -f docker/develop/docker-compose.yml --env-file .env --profile metering up

  • Start the Rust backend cargo run -p meteroid --bin standalone --features="metering-server

  • Start the Web frontend pnpm --prefix modules/web/web-app run dev

You can now access the app at http://localhost:5173

Development

After a pull, you should update/build the dependencies.

  • cargo build -p meteroid
  • cargo build -p metering
  • pnpm install --prefix modules/web

Updating the protobuf files

Protobuf files are found in /modules/meteroid/proto and /modules/metering/proto

After an update, you can rebuild rust, reinstall the web dependencies and generate from proto via the commands in the section "Install the dependencies & build" of this document.

Updating the Open API Specification

Open API specification is generated from routes annotations found in modules/meteroid/src/api_rest Generated file is found in spec/api/v1/openapi.json On every change in the routes, the openapi.json file should be regenerated via the following command:

  • cargo run -p meteroid --bin openapi-generate

Database Migrations

To add new migration, the following steps are needed (executed from the project root):

  • make sure the database server is running
  • make sure diesel_cli is installed : cargo install diesel_cli --no-default-features --features postgres
  • create the migration file : diesel migration generate <migration_name>. Generates empty migration files under modules/meteroid/migrations/diesel
  • add sql code to the generated migration files
  • apply the migration : diesel migration run. Applies the migration(s) and regenerates the schema.rs file.
  • revert the migration : diesel migration revert. Un-applies the last applied migration(s) and regenerates the schema.rs file.

On meteroid_api startup the unapplied migrations run automatically.

See https://diesel.rs/guides/getting-started for more info.

Contributing as a frontend (without rust)

We provide a light docker compose that starts the latest api docker image from the main branch.

Notice that this doesn't start the metering server, nor the automation processes (invoice finalization, payment, generations, etc.), so some functionalities will be missing.

  • copy the .env.example to a .env

  • Start the database and api ;

docker compose -f docker/develop/for-frontends/docker-compose-lite.yml --env-file .env up

  • Start the frontend

pnpm install --prefix modules/web

pnpm --prefix modules/web/web-app dev

You can now access the app at http://localhost:5173