route-bucket-backend

Requirements

• docker: 18.09 or higher
• docker-compose: 1.25.1 or higher

Both of these are for build kit support.

Run the Project

make start

This will start the following 4 containers. (See docker-compose.yml.)

• api: Rust backend server.
• db: MySQL server.
• osrm: OSRM server for route generation.
• swagger: Swagger UI for the backend api.

The root of the app will be at http://localhost:8080/.

For Developpers

Testing

Run

make test

to run cargo-test on the docker container.

Add seed data to the DB

make seed

See api/src/bin/seed.rs.

Change DB schema

After modifying db/schema.sql, run

make migrate-dry-run

to check the diff, and run

make migrate

to migrate the database running on the db container.

Documentation

API Documentation

swagger container will be up with make start. To see the documentation(SwaggerUI), go to http://localhost:4000/

Design Principles

You can see the documentation on our design principles here (japanese version also available).