Installation
How to install and set up Zeta in your project.
Introduction
Learn how to install Zeta, the secure shadcn/ui component registry, in your Next.js project. This guide covers the basics to get you started quickly, with links to more detailed configuration topics.
Prerequisites
- Node.js 18+
- pnpm
- A Next.js app (recommended)
- Polar.sh account for license key management - Create an account
Installation Methods
A. Using shadcn CLI (Recommended)
Install using shadcn
This will copy Zeta registry components into your project.
B. Cloning the Repository
Clone and install Next.js
Basic Configuration
After installation, you need to configure your environment and registry files. For full details, see the Configuration Guide.
1. Environment Variables
Copy .env.example to .env
- Fill in the required values. See Environment Variables Reference for details on each variable.
2. Registry File
- Ensure you have a
registry.json
file and at least one component in your registry directory. - For more information, see Registry File Configuration.
3. Middleware (Optional)
- To protect premium/private components, configure middleware for access control.
- See Middleware Configuration for setup instructions.
First Run
Start the Development Server
Visit http://localhost:3000 to see your registry.
Next Steps
Troubleshooting
- See Zeta Discussions for help.
- Double-check your environment variables and Polar.sh credentials if you encounter issues.