Deployment Documentation - djgamekid/GDP-Group-I-bearcatmanager GitHub Wiki
Deployment Documentation for Event Manager App
🛠️ Tools/Services Used
Tool/Service | Purpose | Link |
---|---|---|
Vite + React | Frontend Framework | vitejs.dev |
Firebase | Backend Services (Firestore, Auth, Storage) | firebase.google.com |
Render | Deployment Platform | render.com |
VS Code | Development Environment | code.visualstudio.com |
Node.js | Runtime Environment | nodejs.org |
Express | Lightweight Server for Production Build | expressjs.com |
Setting Up the Development Environment
1. Prerequisites
Make sure you have the following installed:
- Node.js (LTS) — Runtime environment
- VS Code — Development IDE
- Firebase CLI — For local testing
2. Clone the Repository
git clone https://github.com/your-repo/bearcat-event-manager.git
cd bearcat-event-manager
3. Install Dependencies
npm install
4. Set Up Firebase (if applicable)
Login to Firebase CLI and initialize if needed:
firebase login
firebase init
5. Add Environment Variables
Create a .env
file in the root directory with Firebase config:
VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
VITE_FIREBASE_APP_ID=your_app_id
Directions to Run the Code for Testing
1. Run in Development Mode
npm run dev
- Open http://localhost:5173/ to view the app.
2. Run Firebase Emulators (if applicable)
firebase emulators:start
3. Build for Production
npm run build
4. Run Locally After Build
npm run start
- Open http://localhost:10000/ if using Express.
Deployment on Render
1. Set Up Render Service
- Create a New Web Service on Render.
- Connect to your GitHub Repository.
2. Configure Render Settings
Setting | Value |
---|---|
Build Command | npm install && npm run build |
Start Command | npm run start |
Publish Directory | dist |
3. Add Environment Variables on Render
- Add Firebase variables under the Environment tab.
4. Deploy
- Click Deploy and monitor logs for success.
🔍 Troubleshooting
- Port Errors: Ensure the server binds to 0.0.0.0 and uses process.env.PORT.
- Missing Files: Verify the
dist
folder exists before deploying. - Firebase Issues: Ensure all Firebase variables are correct in both
.env
and Render.
📬 Need Help?
- Check Render Docs for deployment issues.
- Review Firebase Docs for backend issues.
- Reach out to the team via GitHub Issues if you're stuck.