Studio Management System

Getting Started

To startup the app in dev mode we need to setup Docker, run docker-compose, and apply our migrations.

Docker

Ensure you have docker and docker-compose installed. See Get Docker for you device.

Having installed Docker (and potentially restarted editors, installed extensions, etc.), let's start up the application stack in dev mode.

In a console run the following,

docker-compose up

This will build the application stack for the first time and start up the apps in dev mode. This includes,

• the database (MariaDb)
• a reverse proxy (Nginx Proxy Manager)
• an SPA frontend (React Js)

The database data is stored as a Docker volume local to your machine. All important domain data, user accounts, etc. are stored on this volume. If you remove this volume you will incur dataloss. Building the stack will not replace/remove these volumes. ie. you can run docker-compose build without incurring dataloss.

Running the Migrations

Having started up the docker dependencies, let's run the migrations. This is typical EF Core project, read more here

Although you can install and configure your dotnet tools from any location, the project specific commands need to be run from src/server

install the tools (if you haven't already),

dotnet tool install --global dotnet-ef
dotnet tool update --global dotnet-ef

verify your version and installation,

dotnet ef

update the database,

dotnet ef database update --project StudioManagementSystem.Core\StudioManagementSystem.Core.csproj

Accessing the Database for Development Purposes

In development mode, the MariaDb database is exposed via port 33060. The various user credentials are currently under the database/ directory in this repo.

Running and deploying the Production Build

To test the production build locally, you'll need to provide SSL certificates to the app. This example uses mkcert to create a machine-signed certificate.

Windows

choco install mkcert
mkcert -install
mkcert -key-file .certs\key.pem -cert-file .certs\cert.crt studiomanagementsystem.localtest.me

Unix

homebrew install mkcert
mkcert -install
mkcert -key-file .certs/key.pem -cert-file .certs/cert.crt studiomanagementsystem.localtest.me

Successfully generating the machine-signed certs will log something like the following,

Created a new certificate valid for the following names 📜
 - "localhost"

The certificate is at ".certs/cert.crt" and the key at ".certs/key.pem" ✅

It will expire on 23 July 2025 🗓

Running docker-compose up -d --build will build the latest source code and deploy it behind our rerverse proxy. This proxy will run on completion and make the build available at https://studiomanagementsystem.localtest.me

The server/backend API

Read more about the server API here