Skip to content
A bubbly Portr

Setup admin in local

The admin is built using python for the backend and svelte for the frontend.

Requirements

  • rye (0.43.0+)
  • node (20+)
  • pnpm (9.15.0+)
  • postgres (16+)

Frontend setup

Installation

Terminal window
make installclient

Start the client

Terminal window
make runclient

Backend setup

Inside the admin folder, run the following

Terminal window
rye sync

This sets up the relevant python version and install packages in a virtual environment.

Create a new .env using the .env.template file. Make sure the following environment variables are setup,

  • PORTR_ADMIN_ENCRYPTION_KEY
  • PORTR_ADMIN_GITHUB_CLIENT_ID (only required if you need GitHub auth)
  • PORTR_ADMIN_GITHUB_CLIENT_SECRET

Start the server

Terminal window
make runserver

This should run the migrations and start the server. You can access the server at http://localhost:8000

For more commands, check out the admin makefile.

For settings, check out the admin config file.