Marketplace backend

Backend services monorepo to operate the contribution marketplace.

⚠️ WARNING! ⚠️

This repo contains highly experimental code. Expect rapid iteration.

🎟️ Description

🎗️ Prerequisites

1. Setup your environment

Create the .env file with the correct environment variables. Copy the .env.example file and modify the values according to your setup.

2. Start the docker stack

Make sure docker-compose is installed (see Installation instructions).

docker-compose up -d

3. Setup the database

Make sure Diesel CLI is installed (see installation instructions):

Then, use Diesel to initialize the data model and the database:

source .env
diesel setup
diesel migration run

📦 Installation

To build the project, run the following command:

cargo build

🔬 Usage

Below are some examples of usage.

Using Hasura

See Hasura documentation.

For convenience, some commands are available from the root of the repo:

make hasura/start # Apply metadata and start the console

Add a single repository for indexing

cargo run &
curl -d '{"owner":"onlydustxyz", "name":"starkonquest"}' -H "Content-Type: application/json" -X POST http://localhost:8000/projects

🌡️ Testing

cargo test

End-to-end testing

TODO

Migrate database

To create a new migration, start running

diesel migration generate <your-migration-name>

Edit the generated files with your SQL code for up.sql and down.sql
Test your migration up and down by running

diesel migration run
diesel migration revert
diesel migration run

The file schema.rs should be then automatically updated

Monitoring

We use Datadog as a monitoring solution.

$~ heroku drains --json --app onlydust-backend-staging

[
  {
    "id": "459e4e77-bbaa-4be2-8237-98fafe856d19",
    "url": "https://http-intake.logs.datadoghq.eu/api/v2/logs/?dd-api-key=$API_KEY&ddsource=heroku&env=staging&service=marketplace-backend&host=staging.api.onlydust.xyz",
    ...
  }
]

$~ heroku drains --json --app onlydust-backend-production

[
  {
    "id": "c0b077bf-f0cc-4049-80e9-5b55e18d701a",
    "url": "https://http-intake.logs.datadoghq.eu/api/v2/logs/?dd-api-key=$API_KEY&ddsource=heroku&env=production&service=marketplace-backend&host=api.onlydust.xyz",
    ...
  }
]

🫶 Contributing

📄 License

marketplace-backend is released under MIT.

ofux/marketplace-backend