devcontainer_setup.md

Devcontainer Setup

step by step tutorial on how to setup the repo in a devcontainer.

Introduction

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 devcontainer.

The stdlib repository includes a preconfigured devcontainer, making it the easiest way to set up your development environment. It ensures proper linting, EditorConfig, and tooling are configured right from the start.

Prerequisites

setting up the stdlib devcontainer requires the following prerequisites:

• Git: version control
• Docker: containerization
• VS Code: preferred IDE

Download

To acquire the source code, first navigate to the parent directory into which you want to place the project Git repository

$ cd /path/to/parent/destination/directory

Next, clone the repository.

$ git clone https://github.com/stdlib-js/stdlib.git

If you are wanting to contribute to stdlib, first fork the repository and amend the previous command.

$ git clone https://github.com/<username>/stdlib.git

Open the repo in VS Code.

$ cd stdlib && code .

When prompted, Open the repo in the dev container.

Kindly 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 devcontainer installation was successful!