Contributing to Terminal One

Terminal One is open-source with MIT license. Any contribution is highly appreciated!

Setting up

Once you've cloned the repo, first run the following command to install dependencies.

npm ci

To start the app locally, run

npm run dev:app

This repository is a monorepo managed through Turborepo.

app: an Electron that hosts native logic
terminal: an Next.js app that's responsible for the user interface
types: a shared library that mostly contains common types used by other packages in the repo
eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
tsconfig: tsconfig.jsons used throughout the monorepo

This Turborepo utilizes some additional tools: