Welcome to the adrobski-soundesign development environment setup guide. This document provides comprehensive instructions to facilitate a smooth and consistent setup across various development environments.
We use NVM (Node Version Manager) to ensure a consistent Node.js version. Install NVM and set the Node.js version for this project with :
nvm install
Pnpm is the package manager of choice for this project. Make sure you are using at least Node.js 14 (lts/fermium) and then activate it through corepack
:
corepack enable pnpm
To ensure consistent behaviour across all development environments, they should all use the same version of pnpm. That's why an explicit pnpm version is specified in the package.json. Check if your pnpm version is matching the one under the packageManager
property :
pnpm -v
If it is not the case, install the corresponding version :
corepack install
Consistency in TypeScript versions is crucial. For VSCode users, ensure that you use the workspace version of TypeScript and not the built-in version provided by VSCode.
For an enhanced development experience with project-specific editor settings, duplicate .vscode.sample
as .vscode
:
cp -R .vscode.sample .vscode
Ensure that you follow the sections below in sequence to set up your development environment without issues. Documentation is provided to guide you through the major setup steps.
Initiate by setting up environment variables. Duplicate .env.local.sample
as .env.local
:
cp .env.local.sample .env.local
Amend .env.local
with your specific configurations.
Install necessary project dependencies :
pnpm install
To precisely keep track of the dependencies of this application, each dependency should be added with a specific version number.:
pnpm add <pkg> -E
Also, for easier dependency updating, you should use the pnpm interactive mode :
pnpm up -i -L
Execute the app in various modes using :
# Development mode
pnpm dev
# Production mode
pnpm start