https://github.com/mdn/rumba

The clean kuma (🤖🧹)
https://github.com/mdn/rumba

rust

Last synced: 3 months ago
JSON representation

The clean kuma (🤖🧹)

• Host: GitHub
• URL: https://github.com/mdn/rumba
• Owner: mdn
• License: mpl-2.0
• Created: 2022-04-25T12:43:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T09:39:26.000Z (7 months ago)
• Last Synced: 2024-04-08T16:23:44.540Z (7 months ago)
• Topics: rust
• Language: Rust
• Homepage:
• Size: 1.27 MB
• Stars: 49
• Watchers: 7
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Rumba

Rumba is [MDN's](https://developer.mozilla.org) new back-end. It supersedes [kuma](https://github.com/mdn/kuma) and

mainly powers [MDN Plus](https://developer.mozilla.org/en-US/plus).

## Quickstart

Before you can start working with Rumba, you need to:

1. Install [git](https://git-scm.com/) and [Rust](https://www.rust-lang.org/).

2. Install additional dependencies:

   - Mac OS `brew install libpq && brew link --force libpq`

   - Ubuntu: `apt install gcc libpq-dev libssl-dev pkg-config`

3. Run a PostgreSQL instance:

   - Mac OS: e.g. [Postgres.app](https://postgresapp.com/)

   - Docker: `docker run --name postgres -p 5432:5432 -e POSTGRES_USER=rumba -e POSTGRES_PASSWORD=rumba -e POSTGRES_DB=mdn -d postgres`).

4. Run an Elastic instance:

   - Docker: `docker run --name elastic -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" -d elasticsearch:8.3.3`

5. Copy `.settings.dev.toml` to `.settings.toml`.

6. Run `cargo run`.

7. To create an authenticated session navigate to http://localhost:8000/users/fxa/login/authenticate/?next=%2F and login with your firefox staging account

8. To check you are logged in and ready to go navigate to http://localhost:8000/api/v1/whoami you should see your logged in user information.

## Formatting & Linting

All changes to Rumba are required to be formatted with [Rustfmt](https://doc.rust-lang.org/stable/clippy/index.html) (`cargo fmt --all`) and free of [Clippy](https://doc.rust-lang.org/stable/clippy/index.html) linting errors or warnings (`cargo clippy --all --all-features -- -D warnings`).

To avoid committing unformatted or unlinted changes, we recommend setting up a pre-commit [Git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) in your local repository checkout:

```sh

touch .git/hooks/pre-commit

chmod +x .git/hooks/pre-commit

cat <> .git/hooks/pre-commit

#!/usr/bin/env bash

echo "Running cargo fmt..."

cargo fmt --all -- --check

echo "Running cargo clippy..."

cargo clippy --all --all-features -- -D warnings

EOF

```

## Testing

See [tests](./tests/)