90 lines
2.0 KiB
Plaintext
90 lines
2.0 KiB
Plaintext
---
|
|
title: "Quick Start"
|
|
description: "Get your portfolio website running in 10 minutes"
|
|
---
|
|
|
|
# Quick Start Guide
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js 18+ installed
|
|
- Appwrite account ([cloud.appwrite.io](https://cloud.appwrite.io))
|
|
- Git installed
|
|
|
|
## Installation
|
|
|
|
<Steps>
|
|
<Step title="Clone & Install">
|
|
```bash
|
|
git clone <your-repo-url>
|
|
cd portfolio
|
|
npm install
|
|
```
|
|
</Step>
|
|
|
|
<Step title="Configure Environment">
|
|
Create a `.env` file in the root directory:
|
|
|
|
```env
|
|
VITE_APPWRITE_ENDPOINT=https://cloud.appwrite.io/v1
|
|
VITE_APPWRITE_PROJECT_ID=your_project_id
|
|
VITE_APPWRITE_DATABASE_ID=portfolio_db
|
|
VITE_APPWRITE_STORAGE_ID=reactbucket
|
|
```
|
|
|
|
<Note>
|
|
Get these values from your Appwrite Console after creating a project.
|
|
</Note>
|
|
</Step>
|
|
|
|
<Step title="Start Development Server">
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open [http://localhost:5173](http://localhost:5173) in your browser.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## First-Time Setup
|
|
|
|
### 1. Create Admin Account
|
|
|
|
1. Go to `/admin` in your browser
|
|
2. Sign up with your email
|
|
3. Verify your email in Appwrite Console
|
|
|
|
### 2. Set Up Database
|
|
|
|
Follow the [Appwrite Setup Guide](/appwrite/overview) to create:
|
|
- Required collections (blogs, projects, products, etc.)
|
|
- Storage buckets for images
|
|
- Proper permissions
|
|
|
|
### 3. Add Your First Content
|
|
|
|
| Section | Admin URL | What to Add |
|
|
|---------|-----------|-------------|
|
|
| Header | `/admin/header` | Name, roles, description |
|
|
| About | `/admin/about` | Bio, skills, experience |
|
|
| Projects | `/admin/projects` | Portfolio projects |
|
|
| Blog | `/admin/blogs` | Blog posts |
|
|
|
|
## Build for Production
|
|
|
|
```bash
|
|
npm run build
|
|
npm run preview # Test production build locally
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Appwrite Setup" icon="database" href="/appwrite/overview">
|
|
Complete database and storage configuration
|
|
</Card>
|
|
<Card title="Deployment" icon="rocket" href="/deployment">
|
|
Deploy to Vercel or other platforms
|
|
</Card>
|
|
</CardGroup>
|