116d41a284
* feat: add changelog feature and update site navigation - Introduced a new Changelog page with pagination and detailed entry views. - Added components for displaying changelog entries, pagination, and entry details. - Updated site navigation to include a link to the new Changelog page. - Enhanced localization for changelog-related texts in marketing.json. * refactor: enhance Changelog page layout and entry display - Increased the number of changelog entries displayed per page from 2 to 20 for better visibility. - Improved the layout of the Changelog page by adjusting the container styles and removing unnecessary divs. - Updated the ChangelogEntry component to enhance the visual presentation of entries, including a new date badge with an icon. - Refined the CSS styles for Markdoc headings to improve typography and spacing. * refactor: enhance Changelog page functionality and layout - Increased the number of changelog entries displayed per page from 20 to 50 for improved user experience. - Updated ChangelogEntry component to make the highlight prop optional and refined the layout for better visual clarity. - Adjusted styles in ChangelogHeader and ChangelogPagination components for a more cohesive design. - Removed unnecessary order fields from changelog markdown files to streamline content management. * feat: enhance Changelog entry navigation and data loading - Refactored ChangelogEntry page to load previous and next entries for improved navigation. - Introduced ChangelogNavigation component to facilitate navigation between changelog entries. - Updated ChangelogDetail component to display navigation links and entry details. - Enhanced data fetching logic to retrieve all changelog entries alongside the current entry. - Added localization keys for navigation text in marketing.json. * Update package dependencies and enhance documentation layout - Upgraded various packages including @turbo/gen and turbo to version 2.6.0, and react-hook-form to version 7.66.0. - Updated lucide-react to version 0.552.0 across multiple packages. - Refactored documentation layout components for improved styling and structure. - Removed deprecated loading components and adjusted navigation elements for better user experience. - Added placeholder notes in changelog entries for clarity.
134 lines
2.7 KiB
Plaintext
134 lines
2.7 KiB
Plaintext
---
|
|
title: "Quick Start"
|
|
description: "Get your application running in minutes with this quick start guide."
|
|
publishedAt: 2024-04-11
|
|
order: 2
|
|
status: "published"
|
|
---
|
|
|
|
> **Note:** This is mock/placeholder content for demonstration purposes.
|
|
|
|
Get your development environment up and running quickly.
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, ensure you have:
|
|
- **Node.js** 18.x or higher
|
|
- **pnpm** 8.x or higher
|
|
- **Git** for version control
|
|
- A **Supabase** account (free tier works great)
|
|
|
|
## Step 1: Clone the Repository
|
|
|
|
```bash
|
|
git clone https://github.com/yourorg/yourapp.git
|
|
cd yourapp
|
|
```
|
|
|
|
## Step 2: Install Dependencies
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
This will install all required dependencies across the monorepo.
|
|
|
|
## Step 3: Set Up Environment Variables
|
|
|
|
Copy the example environment file:
|
|
|
|
```bash
|
|
cp apps/web/.env.example apps/web/.env.local
|
|
```
|
|
|
|
Update the following variables:
|
|
|
|
```bash
|
|
# Supabase Configuration
|
|
NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
|
|
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key-here
|
|
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key-here
|
|
|
|
# Application
|
|
NEXT_PUBLIC_SITE_URL=http://localhost:3000
|
|
```
|
|
|
|
## Step 4: Start Supabase
|
|
|
|
Start your local Supabase instance:
|
|
|
|
```bash
|
|
pnpm supabase:web:start
|
|
```
|
|
|
|
This will:
|
|
- Start PostgreSQL database
|
|
- Start Supabase Studio (localhost:54323)
|
|
- Apply all migrations
|
|
- Seed initial data
|
|
|
|
## Step 5: Start Development Server
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Your application will be available at:
|
|
- **App**: http://localhost:3000
|
|
- **Supabase Studio**: http://localhost:54323
|
|
- **Email Testing**: http://localhost:54324
|
|
|
|
## Step 6: Create Your First User
|
|
|
|
1. Navigate to http://localhost:3000/auth/sign-up
|
|
2. Enter your email and password
|
|
3. Check http://localhost:54324 for the confirmation email
|
|
4. Click the confirmation link
|
|
5. You're ready to go!
|
|
|
|
## Next Steps
|
|
|
|
Now that your app is running:
|
|
|
|
1. **Explore the Dashboard** - Check out the main features
|
|
2. **Review the Code** - Familiarize yourself with the structure
|
|
3. **Read the Docs** - Learn about key concepts
|
|
4. **Build Your Feature** - Start customizing
|
|
|
|
## Common Issues
|
|
|
|
### Port Already in Use
|
|
|
|
If port 3000 is already in use:
|
|
|
|
```bash
|
|
# Find and kill the process
|
|
lsof -i :3000
|
|
kill -9 <PID>
|
|
```
|
|
|
|
### Supabase Won't Start
|
|
|
|
Try resetting Supabase:
|
|
|
|
```bash
|
|
pnpm supabase:web:stop
|
|
docker system prune -a # Clean Docker
|
|
pnpm supabase:web:start
|
|
```
|
|
|
|
### Database Connection Error
|
|
|
|
Ensure Docker is running and restart Supabase:
|
|
|
|
```bash
|
|
docker ps # Check Docker is running
|
|
pnpm supabase:web:reset
|
|
```
|
|
|
|
## What's Next?
|
|
|
|
- Learn about the [project structure](/docs/getting-started/project-structure)
|
|
- Understand [configuration options](/docs/getting-started/configuration)
|
|
- Follow [best practices](/docs/development/workflow)
|