Step-by-step tutorial on how to set up a stdlib development environment in a dev container.
We appreciate your interest in contributing to stdlib! Below, we've provided a step-by-step tutorial on how to set up the project locally on your device using a dev container.
Dev containers, are Docker containers that are specifically configured to provide a fully featured development environment with the right tooling, extensions, linting and formatting. They allow you to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code's full feature set.
The stdlib repository includes a preconfigured dev container, making it the easiest way to set up your development environment. It ensures proper linting, EditorConfig, and tooling are configured right from the start.
Note: The dev container does not yet support ARM64 architectures. For more information, or if you're interested in adding ARM64 support, you can visit this issue.
Setting up the stdlib dev container requires the following prerequisites:
To acquire the source code, first navigate to the parent directory where you want to place the project's Git repository.
$ cd /path/to/parent/destination/directoryNext, clone the repository.
$ git clone https://github.com/stdlib-js/stdlib.gitIf you are wanting to contribute to stdlib, first fork the repository and amend the previous command.
$ git clone https://github.com/<username>/stdlib.gitOpen the repository in VS Code.
$ cd stdlib && code .When prompted, open the repository in the dev container.
Please be patient, as the post-create script may take some time to install all the required languages and dependencies.
Close the terminal and wait for other dependencies to install.
Close the terminal after the installation is completed.
If you see this when you open the terminal, then the dev container installation was successful!
