> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.clubedge.live/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get your Clubedge development environment ready and start working with the platform.

## Get started in three steps

Set up your development environment, get familiar with the Clubedge workflow, and run your first project locally.

### Step 1: Set up your local environment

<AccordionGroup>
  <Accordion title="Clone the project locally" icon="copy">
    Start by cloning the repository for the Clubedge project you're working on.

    ```bash theme={null}
    git clone <repository-url>
    cd <project-directory>
    ```

    Make sure you have access to the repository and are working from the correct branch before making changes.

    Check the project's `README.md` for any project-specific setup requirements.
  </Accordion>

  <Accordion title="Install dependencies and configure your environment" icon="rectangle-terminal">
    Install the dependencies using the package manager defined by the project.

    For Node.js projects, this will typically look like:

    ```bash theme={null}
    pnpm install
    ```

    Copy the project's environment template if one is provided:

    ```bash theme={null}
    cp .env.example .env
    ```

    Configure the required environment variables using the project's development documentation.

    <Tip>
      Never commit `.env` files, credentials, API keys, or other secrets to the repository.
    </Tip>
  </Accordion>
</AccordionGroup>

### Step 2: Run the project locally

<AccordionGroup>
  <Accordion title="Start the development server" icon="play">
    Follow the project's development instructions to start the application locally.

    For many Clubedge services, this will be similar to:

    ```bash theme={null}
    pnpm dev
    ```

    Once the server is running, open the local URL provided by the project.

    <Tip>
      Check the project's `README.md` and development documentation for the exact commands and required services.
    </Tip>
  </Accordion>

  <Accordion title="Verify your setup" icon="check">
    Before making changes, verify that the project is working correctly.

    A typical setup check includes:

    1. Starting the application successfully.
    2. Running the project's test suite.
    3. Checking that required services are available.
    4. Confirming that the application responds as expected.

    For example:

    ```bash theme={null}
    pnpm test
    ```

    The exact commands depend on the project you're working on.
  </Accordion>
</AccordionGroup>

### Step 3: Make your first change

<Accordion title="Create a branch and open a pull request" icon="code-branch">
  Create a branch for your work instead of committing directly to the main branch.

  ```bash theme={null}
  git checkout -b feat/your-change
  ```

  Make your changes, then run the project's checks before committing:

  ```bash theme={null}
  pnpm lint
  pnpm test
  ```

  Commit your changes using the project's commit conventions:

  ```bash theme={null}
  git add .
  git commit -m "feat: describe your change"
  ```

  Push your branch and open a pull request for review.

  <Tip>
    Check the project's contribution guidelines for its branch naming, commit, testing, and pull request requirements.
  </Tip>
</Accordion>

## Next steps

Now that your local environment is ready, explore the resources relevant to your work:

<CardGroup cols={2}>
  <Card title="Development" icon="code" href="/development">
    Learn about the Clubedge development workflow, project conventions, and contribution process.
  </Card>

  <Card title="Products & services" icon="grid-2">
    Explore the Clubedge products and services available to your application.
  </Card>

  <Card title="Integration" icon="plug">
    Learn how to integrate Clubedge services into your application.
  </Card>
</CardGroup>

<Note>
  **Working on a specific Clubedge product?** Start with its product documentation for project-specific setup, integration instructions, architecture, and API details.
</Note>