database

An interactive interface to the OSF supabase database

Development

Prerequisites

• Rust
  • Install Rust 1.70
• Shuttle
  • Install Shuttle 0.18.0

Setup

• Create a fork and clone the repository
• Open the cloned repository in your editor of choice and access the terminal
• Move to the api directory - cd api
• Create a new file - Secrets.toml and populate it as per .env-example
  • Note - only the variables marked DEV and the SECRET variable are required for dev
• Run the project - cargo shuttle run
• Access the API using something like Postman or by running the frontend locally.