Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.37 KB

Contributing

Inlang is set up as monorepo with Nx (with caching some compile process for better dev/build performance).

Getting started

  1. Clone/Fork inlang's repository.
  2. Open the repository folder in Visual Studio Code.
  3. pnpm install to install dependencies.
  4. pnpm fetch-env:public to fetch necessary environment variables for the production build. (only for external contributor)
  5. pnpm dev to run the development environment.
  6. pnpm test to run the tests.
  7. pnpm build to compile a production build.

For Windows users

To work on Windows, you will need to change the shell, which is used to execute NPM scripts to bash, before running pnpm dev. A Git installation usually comes with a bash binary.

  • pnpm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe" to set the shell to bash provided by your Git installation

Notice

If you get the following error:

Nx failed to execute {runtime: 'env | grep ^PUBLIC_'}. Error: Command failed: env | grep ^PUBLIC_

run pnpm fetch-env:public to fetch necessary environment variables.

then start your work.

Debugging

  1. Run pnpm dev.
  2. Several debug launch configs can be found in the VSCode side menu. Select the correct one depending on the subject of your contribution and launch Debug mode.