Skip to main content

Development

Welcome to the development guide for this project! This document will walk you through the steps required to set up your local environment, run the development server, and contribute effectively using pnpm. Let’s get started!

1. Prerequisites​

Before you begin, ensure you have the following installed on your system:

  • Node.js (v18 or higher): Download Node.js

    Node.js Logo

  • pnpm: Install pnpm globally using the following command:

    npm install -g pnpm
    pnpm Logo

2. Setting Up the Development Environment​

Follow these steps to set up your local development environment:

  1. Clone the Repository

    git clone <https://github.com/MambaCodes/wstack.git>

  2. Install Dependencies

    pnpm install

  3. Start the Development Server

    pnpm dev

⚠️ Possible Issue: Missing .env File​

If you encounter errors when running pnpm dev, it might be due to a missing .env file.

✅ Setting Up the .env File:​

  1. Create a .env file in the root of your project.
  2. Copy the required environment variables from .env.example (if available).
  3. Fill in the necessary values based on your project’s requirements.
  4. Restart the development server after setting up the .env file.
Important

For better understanding of configuration of the .env file, read configurations docs.