Welcome
This guide helps you set up the project locally in just a few minutes. You’ll install dependencies, run the dev server, and learn the basics of the project structure.
Prerequisites
Make sure you have the following installed:
- Node.js (LTS recommended)
- Yarn or npm
- Git
If you don’t have yarn
, install it globally:
npm install -g yarn
Install & Run
# Clone the repo
git clone https://github.com/your-org/your-repo.git
cd your-repo
# Install dependencies
yarn install
# Start dev server
yarn dev
The app should now be running at http://localhost:3000
.
Project Structure
The main folders are:
app/
— App Router pages and layoutscomponents/
— shared UI componentscontent/
— markdown/MDX content for blog and docscms/
— CMS configuration and collectionslib/
— utilities and helpers
Next Steps
- Explore Features to see what’s included
- Open CMS > Docs to edit documentation
- Check Deployment for going live