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

# Quickstart

> Set up a local copy of Plazen

## Get started in three steps

### Step 1: Set up your own fork

<AccordionGroup>
  <Accordion title="Fork the Plazen repository" icon="copy">
    Go to [our repository](https://github.com/plazen/plazen) and fork the repository

    <img src="https://mintcdn.com/plazen/VlSJtUjIvqScFqT8/images/Screenshot2026-01-06at12.26.12.png?fit=max&auto=format&n=VlSJtUjIvqScFqT8&q=85&s=7f782713c7dda8fa89a9dc0b947b53a7" alt="Screenshot 2026 01 06 At 12 26 12" width="2248" height="154" data-path="images/Screenshot2026-01-06at12.26.12.png" />
  </Accordion>

  <Accordion title="Clone the repository" icon="rectangle-terminal">
    `git clone https://github.com/<your-username>/plazen.git`
  </Accordion>
</AccordionGroup>

### Step 2: Set up the local enviroment.

<AccordionGroup>
  <Accordion title="Set up a new Supabase project" icon="database">
    We use Supabase for our database and Auth.

    <img src="https://mintcdn.com/plazen/VlSJtUjIvqScFqT8/images/Screenshot2026-01-06at12.35.46.png?fit=max&auto=format&n=VlSJtUjIvqScFqT8&q=85&s=3ead6430079d8e3376207c1438fb8cb4" alt="Screenshot 2026 01 06 At 12 35 46" width="1566" height="1360" data-path="images/Screenshot2026-01-06at12.35.46.png" />

    \
    To create a new project:\
    Type in the name and a strong password (will be needed later)
  </Accordion>

  <Accordion title="Update local environment" icon="user-secret">
    To set up the project, you need to configure your environment secrets

    1. Copy the example environment file 

       ```
       cp env.example .env
       ```
    2. Fill in all of your secrets

    <Tip>
      Follow the full guide [here](/dev/full-setup), if you don't know how to complete this part!
    </Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Start the project!

<Accordion title="Publish your Plazen" icon="rocket">
  Use any hosting service (e.g. we use vercel) and start the project!\
  \
  For local use:

  ```
  npm run dev
  ```
</Accordion>

## Next steps

Now that you have your local copy, explore these key features:

<CardGroup cols={2}>
  <Card title="API documentation" icon="code" href="/api-reference/apis/index" />
</CardGroup>

<Note>
  **Need help?** Join our [community](https://github.com/plazen/plazen/discussions), or contact [support](https://plazen.org/support)
</Note>