> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plec-it.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get PLEC running locally: clone repos, install deps, and boot frontend + backend.

## Get started in three steps

This guide is for new engineers who want to get the PLEC platform running locally.

### Step 1: Clone the repos

<AccordionGroup>
  <Accordion icon="code-branch" title="Clone frontend + backend">
    **Frontend (Web)**

    ```bash theme={null}
    git clone https://github.com/DevAtVenues/platform-frontend.git
    ```

    **Backend (API)**

    ```bash theme={null}
    git clone https://github.com/DevAtVenues/platform-backend.git
    ```

    <Tip>Put both repos in the same parent folder (e.g. <code>\~/projects/plec/</code>) for an easier dev flow.</Tip>
  </Accordion>

  <Accordion icon="folder-open" title="Recommended folder structure">
    ```text theme={null}
    plec/
      platform-frontend/
      platform-backend/
    ```
  </Accordion>
</AccordionGroup>

### Step 2: Install deps + run locally

<AccordionGroup>
  <Accordion icon="rectangle-terminal" title="Frontend: install + start dev server">
    From the frontend repo:

    ```bash theme={null}
    cd platform-frontend
    npm install
    npm run dev
    ```

    <Tip>Your frontend dev server should print the local URL (commonly <code>[http://localhost:5173](http://localhost:5173)</code>).</Tip>
  </Accordion>

  <Accordion icon="server" title="Backend: install + start API server">
    From the backend repo:

    ```bash theme={null}
    cd platform-backend
    npm install
    npm run start:dev
    ```

    <Tip>
      If port <code>3000</code> is in use, you can run on another port:
      <code>PORT=3001 npm run start:dev</code>
    </Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Verify everything is working

<AccordionGroup>
  <Accordion icon="circle-check" title="Quick health checks">
    **Backend health**

    ```bash theme={null}
    curl -s http://localhost:3000/health
    ```

    **OpenAPI JSON (used by Mintlify)**

    ```bash theme={null}
    curl -s http://localhost:3000/docs-json | jq '.openapi, (.paths|length)'
    ```

    <Tip>If your backend is running on 3001, update the URLs accordingly.</Tip>
  </Accordion>

  <Accordion icon="link" title="Connect frontend → backend">
    Make sure your frontend points to the backend base URL you’re running locally (commonly <code>[http://localhost:3000](http://localhost:3000)</code> or <code>[http://localhost:3001](http://localhost:3001)</code>).

    <Tip>Check the frontend’s <code>.env\*</code> files for something like <code>VITE\_API\_URL</code> / <code>VITE\_API\_BASE\_URL</code>.</Tip>
  </Accordion>
</AccordionGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Local development details" icon="laptop-code" href="/development">
    Environment variables, common issues, and debugging.
  </Card>

  <Card title="API reference" icon="terminal" href="/api-reference/introduction">
    Explore endpoints and test requests in the playground.
  </Card>

  <Card title="Docs navigation" icon="map" href="/essentials/navigation">
    How the docs structure works and how to add pages.
  </Card>

  <Card title="Writing MDX" icon="pen-fancy" href="/essentials/markdown">
    Add guides and engineering notes quickly.
  </Card>
</CardGroup>

<Note>
  If you get stuck: confirm ports, confirm environment variables, and check the backend logs for CORS or missing config errors.
</Note>