5ce716d2ab
Moved documentation files into a new docs/ directory and added a documentation index (docs/README.md). Updated the main README with improved project and documentation details. Set explicit API environment variables in Dockerfile for production. Enhanced next.config.mjs with improved API_BASE_URL handling and logging for better deployment clarity.
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
# 📚 Ember Market Frontend Documentation
|
|
|
|
Welcome to the Ember Market Frontend documentation. This folder contains all technical documentation, guides, and references for the project.
|
|
|
|
## 📋 Documentation Index
|
|
|
|
### 🚀 Deployment & Infrastructure
|
|
- **[CapRover Deployment Fix](./CAPROVER-DEPLOYMENT-FIX.md)** - Fixes for 500 errors and environment variable configuration
|
|
- **[Optimized Build](./OPTIMIZED-BUILD.md)** - Build optimization strategies and performance improvements
|
|
|
|
### 📊 Features & Analytics
|
|
- **[Analytics](./ANALYTICS.md)** - Analytics implementation and data insights documentation
|
|
|
|
### 🛠️ Development
|
|
- **[Lib Documentation](./lib-readme.md)** - Library utilities and helper functions
|
|
|
|
## 🏗️ Project Structure
|
|
|
|
```
|
|
docs/
|
|
├── README.md # This index file
|
|
├── CAPROVER-DEPLOYMENT-FIX.md # Deployment troubleshooting
|
|
├── ANALYTICS.md # Analytics documentation
|
|
├── OPTIMIZED-BUILD.md # Build optimization guide
|
|
└── lib-readme.md # Library utilities guide
|
|
```
|
|
|
|
## 🔗 Related Documentation
|
|
|
|
- **[Main README](../README.md)** - Project overview and setup instructions
|
|
- **[Backend Documentation](../../ember-market-backend/README.md)** - Backend API documentation
|
|
- **[Payments Documentation](../../ember-market-payments/README.md)** - Payment system documentation
|
|
|
|
## 📝 Contributing to Documentation
|
|
|
|
When adding new documentation:
|
|
|
|
1. Create `.md` files in this `docs/` folder
|
|
2. Update this README.md index
|
|
3. Use clear, descriptive filenames
|
|
4. Include relevant emojis for easy scanning
|
|
5. Cross-reference related documents
|
|
|
|
## 🏷️ Document Categories
|
|
|
|
- **🚀 Deployment** - CapRover, Docker, environment setup
|
|
- **📊 Analytics** - Data tracking, insights, reporting
|
|
- **🛠️ Development** - Code guides, utilities, best practices
|
|
- **🔧 Configuration** - Environment variables, API setup
|
|
- **🐛 Troubleshooting** - Common issues and fixes
|
|
|