Skip to content

Quickstart

This guide provides an overview of the current repository structure for OxideAuth and outlines the roadmap for future unified deployments.

Architecture & Current Repositories

Currently, OxideAuth is divided into two distinct repositories. In the future, these will be merged into a single monorepo, enabling you to build, deploy, and run a local version simultaneously. At this time, running a local version is not officially supported.

To explore the codebases, you can find the repositories here:

  1. OxideAuth Core API (Rust) Handles all identity processing, JSON Web Tokens, roles, and the database schema.
    View API Repository

  2. OxideAuth Admin Dashboard (React) Provides the visual interface to manage users, services, and roles utilizing the Core API.
    View Dashboard Repository

Future Roadmap: The Monorepo

We are actively working towards combining the API and the UI into a unified monorepo. Once completed, you will be able to:

  • Clone a single repository.
  • Run a single docker compose up or cargo run command.
  • Have the backend and frontend automatically configured to communicate with one another in a local development environment.

Until the monorepo migration is finalized, please refer to the live example environment or explore the source code of the separate projects directly.

Exploring the Live Instance

If you want to see OxideAuth in action without compiling any code, check out our live running instance:

You can use this environment alongside the API Reference to understand how requests and responses are structured.