This section explains the content of the important folder /src
.
/overmind/*
: Contains multiple run-time "storage" classes build with overmind. These store various information at run-time between each code execution./TerminalManager/index.ts
: The heart of the web application. Contains the source code that handles all user in- and output./TerminalManager/commands/*
: Each file represents an executable command./utils/ApiUtil.ts
: Class and instance to communicate with the backend application.
This section describes the development setup to run the web application locally.
Make sure that you have commit signing active for this repository git config commit.gpgsign true
.
We have also set up a
.devcontainer
. Learn more
- Node with NPM installed (https://nodejs.org/en/download/)
Run npm ci
to install all required node modules.
Run npm start
at the root of the directory. Other available commands are
npm run preview
: Spawns a small http-server to serve thedist
folder on port 8080npm run build
: Compiles the current source code to a production ready version atdist
Icon by Bootstrap published under MIT licence.