Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

Latest commit

 

History

History
74 lines (55 loc) · 1.92 KB

File metadata and controls

74 lines (55 loc) · 1.92 KB
title Quickstart
description Set up a local copy of Plazen
icon rocket-launch

Get started in three steps

Step 1: Set up your own fork

Go to [our repository](https://github.com/plazen/plazen) and fork the repository
![Screenshot 2026 01 06 At 12 26 12](/images/Screenshot2026-01-06at12.26.12.png)
`git clone https://github.com//plazen.git`

Step 2: Set up the local enviroment.

We use Supabase for our database and Auth.
![Screenshot 2026 01 06 At 12 35 46](/images/Screenshot2026-01-06at12.35.46.png)

\
To create a new project:\
Type in the name and a strong password (will be needed later)
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>

Step 3: Start the project!

Use any hosting service (e.g. we use vercel) and start the project!\ \ For local use:
npm run dev

Next steps

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

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