Mini File Encryptor - Contributing

All the business rules are encapsulated in /packages/core, while the frontend source code is in /apps.

This monorepo is managed using Turborepo.

General Commands

Run the following command in the root directory to install all the packages required by the monorepo.

npm install

Run the following command to build all the packages in /packages.

npm run build

Run the following command to run all the tests in /packages.

npm run test

Run the following command to launch the app in dev mode.

npm run start

Run the following command to package the app into an executable.

npm run package

Run the following command to package the app into an executable and make a distributable.

npm run make

Run the following command to package the app into an executable, make a distributable and publish to GitHub Releases.

Note that GITHUB_TOKEN is required to be set in the environment before running this command. It is set in GitHub Actions by default.

npm run publish

Run the following command to install a package in a specific workspace.

npm install <package> --workspace=<workspace>

https://docs.github.com/en/actions/learn-github-actions/variables
https://docs.github.com/en/actions/security-guides/automatic-token-authentication