-
Create a new repository using this template. You can do this by clicking the "Use this template" button on the repository page or by clicking here.
-
Clone your new repository.
-
Install dependencies.
pnpm install
-
Configure the environment variables. You can do this by copying the
.env.example
file to.env
and filling in the values or by modifying theconfig/environment.ts
defaults. -
Start the development server.
pnpm dev
Note that this template is meant to be customized. Here are some things you might want to change:
- The
name
field in thepackage.json
file. - The
title
and<meta>
tags in theindex.html
file. - The favicons in the
public/icons
folder. You can use this generator to generate them from an image. - The github username and email in the
integration.yaml
file. - The environment variables in the
Dockerfile
to match your production environment. Note that this is needed because, as React is a client-side framework, the environment variables are embedded in the build.