Carlos Valente
de9a7a87fd
* refactor(project structure): UI * refactor(project structure): extract utilities * refactor(project structure): remove unused * refactor(project structure): electron * refactor(project structure): server refactor: migrate to vitest refactor: monorepo config * refactor: extract application menu * refactor: exit process * refactor: extract tray menu * chore: electron build * Added Seconds in studio clock #282 --------- Co-authored-by: Fabian Posenau <fabian@fphome.de> --------- Co-authored-by: Fabian Posenau <fabian.p99@gmx.de> Co-authored-by: Fabian Posenau <fabian@fphome.de>
2.0 KiB
GETTING STARTED
Ontime consists of 3 distinct parts
- client: A React app for Ontime's UI and web clients
- electron: An electron app which facilitates the cross-platform distribution of Ontime
- server: A node application which handles the domains services and integrations
The steps below will assume you have locally installed the necessary dependencies. Other dependencies will be installed as part of the setup
- node (>=16.16)
- pnpm (>=7)
- docker (only necessary to run and build docker images)
LOCAL DEVELOPMENT
The electron app is only necessary to distribute an installable version of the app and is not required for local development. Locally, we would need to run both the React client and the node.js server in development mode
From the project root, run the following commands
- Install the project dependencies by running
pnpm i - Run dev mode by running
turbo dev
CREATE AN INSTALLABLE FILE (Windows | MacOS | Linux)
Ontime uses Electron to distribute the application. You can generate a distribution for your OS by running the following steps.
From the project root, run the following commands
- Install the project dependencies by running
pnpm i - Build the UI and server by running
turbo build - Create the package by running
turbo dist-win,turbo dist-macorturbo dist-linux
The build distribution assets will be at .apps/electron/dist
DOCKER
Ontime provides a docker-compose file to aid with building and running docker images. While it should allow for a generic setup, it might need to be modified to fit your infrastructure.
From the project root, run the following commands
- Install the project dependencies by running
pnpm i - Build docker image from by running
docker build -t getontime/ontime - Run docker image from compose by running
docker-compose up -d
Other useful commands
- List running processes by running
docker ps - Kill running process by running
docker kill <process-id>