145 lines
3.1 KiB
Markdown
145 lines
3.1 KiB
Markdown
# 🚀 Quick Start Guide
|
|
|
|
Get your LFG9 Forums testing environment running in minutes!
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js 18+ installed
|
|
- AWS credentials configured (already done ✅)
|
|
- Internet connection
|
|
|
|
## Quick Setup (5 minutes)
|
|
|
|
### 1. Install Dependencies
|
|
|
|
```bash
|
|
# Navigate to project root
|
|
cd lfg9-forums
|
|
|
|
# Install all dependencies for both frontend and backend
|
|
npm run setup
|
|
```
|
|
|
|
### 2. Set Up Database Tables
|
|
|
|
```bash
|
|
# Create DynamoDB tables in AWS
|
|
npm run setup-db
|
|
```
|
|
|
|
### 3. Start Development Servers
|
|
|
|
```bash
|
|
# Start both frontend and backend servers
|
|
npm run dev
|
|
```
|
|
|
|
This will start:
|
|
- **Backend API**: http://localhost:3000
|
|
- **Frontend App**: http://localhost:5173
|
|
|
|
## 🎯 What You'll See
|
|
|
|
1. **Homepage**: Beautiful dark-themed landing page
|
|
2. **Authentication**: Login/Register with the dark UI
|
|
3. **Categories**: Forum categories listing
|
|
4. **Rich Text Editor**: TipTap editor with all formatting options
|
|
|
|
## 🔧 Manual Setup (Alternative)
|
|
|
|
If the quick setup doesn't work, you can start services individually:
|
|
|
|
### Backend
|
|
|
|
```bash
|
|
cd backend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### Frontend
|
|
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## 📊 Test the Application
|
|
|
|
1. **Visit**: http://localhost:5173
|
|
2. **Register**: Create a new account
|
|
3. **Browse**: Check out the categories page
|
|
4. **Experience**: The dark theme and rich text editor
|
|
|
|
## 🛠️ Troubleshooting
|
|
|
|
### DynamoDB Connection Issues
|
|
|
|
If tables don't create automatically:
|
|
|
|
```bash
|
|
# Verify AWS credentials
|
|
aws sts get-caller-identity
|
|
|
|
# Manually create tables
|
|
node setup-dev-tables.js
|
|
```
|
|
|
|
### Port Conflicts
|
|
|
|
If ports 3000 or 5173 are in use:
|
|
|
|
**Backend (.env)**:
|
|
```
|
|
PORT=3001
|
|
```
|
|
|
|
**Frontend**: Vite will auto-detect and suggest alternative ports
|
|
|
|
### CORS Issues
|
|
|
|
Make sure the CORS origin in `backend/.env` matches your frontend URL:
|
|
```
|
|
CORS_ORIGIN=http://localhost:5173
|
|
```
|
|
|
|
## 🎨 Features to Test
|
|
|
|
- ✅ **Dark Theme**: Custom color palette throughout
|
|
- ✅ **Authentication**: Register/Login system
|
|
- ✅ **Responsive Design**: Test on mobile/tablet
|
|
- ✅ **Rich Text Editor**: Try all formatting options
|
|
- ✅ **Navigation**: Header menu and routing
|
|
- ✅ **Error Handling**: See validation messages
|
|
|
|
## 🔄 Development Workflow
|
|
|
|
1. **Backend changes**: Auto-restart with nodemon
|
|
2. **Frontend changes**: Hot module reload with Vite
|
|
3. **Database**: Tables persist in AWS DynamoDB
|
|
4. **Files**: S3 bucket for file uploads
|
|
|
|
## 📁 Important URLs
|
|
|
|
- **Frontend**: http://localhost:5173
|
|
- **Backend API**: http://localhost:3000
|
|
- **Health Check**: http://localhost:3000/health
|
|
- **AWS Console**: https://console.aws.amazon.com/dynamodb/
|
|
|
|
## ⚡ Next Steps
|
|
|
|
1. **Create Categories**: Add forum categories (admin required)
|
|
2. **Post Content**: Test the rich text editor
|
|
3. **Upload Images**: Try file uploads to S3
|
|
4. **Mobile Testing**: Check responsive design
|
|
5. **Customize**: Modify colors or add features
|
|
|
|
## 🆘 Need Help?
|
|
|
|
- Check browser console for errors
|
|
- Verify AWS credentials and permissions
|
|
- Ensure all dependencies installed correctly
|
|
- Look at the server logs for API issues
|
|
|
|
**Enjoy testing your LFG9 Forums application! 🎮✨** |