Getting Started

Get started with FreeAuth by creating a new project or adding it to an existing FastAPI application.

Play online

You can start playing with FreeAuth Demo in your browser:

Try FreeAuth Now

Create a new project

FastAPI REST API Server

  1. Clone the backend repository:
git clone git@github.com:decentfox/freeauth-api.git
cd freeauth-api
  1. Install the dependencies, prep environment and initial project:
make setup

During the first installation, you will enter an interactive session to initialize the EdgeDB project:

Specify the name of EdgeDB instance to use with this project [default: FreeAuth]: 
> FreeAuth
In the final step of the installation, an administrator account will be automatically generated for you. Please do remember the login username and initial password, as they will be used to access the admin website for further configuration.
  1. Run the dev command to start FreeAuth server in development mode:
make dev
✨ Well done! Open Swagger UI or ReDoc to view the automatic API documents in the browser.

Quasar Admin

  1. Clone the frontend repository:
git clone git@github.com:decentfox/freeauth-admin.git
cd freeauth-admin
  1. Install the dependencies:
yarn
yarn
  1. Run the dev command to start FreeAuth admin app in development mode:
yarn
yarn dev
✨ Well done! Open http://localhost:8300 to view it in the browser.
Edit this page on GitHub
Table of Contents