Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 1.89 KB
title shortTitle href description
Contributing to inlang
Contributing
/documentation/contributing
Learn on how to contribute to inlang and its ecosystem.

Contributing

Inlang is set up as monorepo with NPM workspaces and turborepo.

Furthermore, the repository makes use of Dev Containers, ensuring that everyone works in the same environment. If you don't use dev containers, we won't be able to support dev-related setup problems.

Getting started

Make sure you have Git, Docker, Visual Studio Code and the VSCode DevContainers Extension installed. Provide your Docker setup with plenty of memory (>4GB). If you are a Windows user, please read the subsection below.

  1. Clone inlang's repository.
  2. Open the repository folder in Visual Studio Code.
  3. Run Dev Containers: Reopen in Container via CTRL + Shift + P or ⌘ + Shift + P.
  4. npm install to install dependencies.
  5. npm run dev to run the development environment.
  6. npm run test to run the tests.
  7. npm run build to compile a production build.

For Windows users

Install Windows Subsystem Linux 2 (WSL 2) as well. Make sure that the user has the right to edit files. For Docker Desktop, the user should be node.

  1. Start Visual Studio Code.
  2. Run Dev Containers: Clone Repository in Container Volume... via CTRL + Shift + P.
  3. npm install to install dependencies.
  4. npm run dev to run the development environment.
  5. npm run test to run the tests.
  6. npm run build to compile a production build.

Debugging

  1. Run npm run dev.
  2. Several debug launch configs can be found in the VSCode side menu.