Skip to main content

Local development environment

Setting up a local development environment gives you full control and offline capabilities. You'll need Node.js, npm, and a code editor installed on your machine.

Alternative: Cloud development

You can develop in GitHub Codespaces using VS Code in your browser - no local installation required.

Prerequisites​

Install Node.js and npm​

Recommended version: Node.js v22.13.0 or later

Option 1: Direct download Download Node.js from https://nodejs.org (npm is included automatically)

Option 2: Using Node Version Manager (recommended) NVM allows you to install and switch between Node.js versions easily:

# Install specific Node.js version
nvm install 22.13.0
nvm use 22.13.0

# Verify installation
node --version
npm --version

Install a code editor​

Recommended: VS Code with Comind extensions

Alternatives: Cursor, WindSurf, or other VS Code-based editors that support extensions

Repository setup​

Step 1: Clone your repository​

Clone your organization's repository (you should have received access from your admin):

git clone https://github.com/comindwork/your-org.git
cd your-org
Authentication issues?

If you encounter GitHub authentication problems:

  • Check status: gh auth status
  • Login: gh auth login

Step 2: Open in VS Code​

  1. Open the repository folder in VS Code
  2. Important: Accept the prompt to install recommended extensions

Step 3: Verify your setup​

Test that everything works by running these commands in the VS Code Terminal:

# Copy sample environment variables
cp .config/dev.env.sample .config/dev.env

# Install dependencies and run tests
npm install
npm test

If all commands succeed, you're ready to start developing Comind apps!

Next steps​

✅ Setup complete! Now you should: