Set Up Resumen
in Minutes

Before you begin, ensure you have the following ready:

All configuration is managed in a single file: .env. Open the .env file in the root directory and fill in the following details:

You need to set up a Firebase project for Authentication and Database.

1. Create a new project
   Go to the Firebase Console and create a new project.
2. Enable Authentication
   1. Go to Build > Authentication.
   2. Click Get Started.
   3. Enable Email/Password and Google sign-in providers.
3. Enable Firestore Database
   1. Go to Build > Firestore Database.
   2. Click Create Database.
   3. Start in Production mode.
   4. Choose a location.
4. Enable Realtime Database
   1. Go to Build > Realtime Database.
   2. Click Create Database.
   3. Choose a location.
   4. Security Rules:

   • Realtime Database: Use the rules provided in Resumen v1.x.0/Realtime_database_Security_rules.txt.
   • Firestore Database: Use the rules provided in Resumen v1.x.0/SecurityRules.txt.
5. Get Configuration Keys
   1. Go to Project Settings (gear icon > Project settings).
   2. Scroll down to Your apps.
   3. Click the Web icon (</>) to create a web app.
   4. Register the app (you don't need Firebase Hosting).
   5. You will see a const firebaseConfig = { ... } object.
   6. Copy the values to your .env file corresponding to:

   • VITE_FIREBASE_KEY (apiKey)
   • VITE_FIREBASE_DOMAIN (authDomain)
   • VITE_FIREBASE_PROJECT_ID (projectId)
   • VITE_FIREBASE_STORAGE_BUCKET (storageBucket)
   • VITE_FIREBASE_SENDER_ID (messagingSenderId)
   • VITE_FIREBASE_APP_ID (appId)
   • VITE_FIREBASE_DATABASE_URL (databaseURL - Note: if you can't find this, it means you haven't created a realtime database)

1. Prepare & Upload the Project
   Compress the Project: On your local machine, zip the entire project folder (including the .env file you just edited).
   💻

   Windows: Right-click the folder → Send to → Compressed (zipped) folder. Name it resume.zip.
   Mac/Linux: Run zip -r resume.zip . inside the project folder.
   Transfer to Server: Use scp to upload the zip file to your server:
   bash Copy

   scp path/to/resume.zip root@YOUR_SERVER_IP:/root/

   Replace path/to/resume.zip with the actual path and YOUR_SERVER_IP with your server's IP address.
   Connect to Server:
   bash Copy

   ssh root@YOUR_SERVER_IP

   Prepare the Server:
   bash Copy

   apt-get update
   apt-get install unzip

   Extract the Project:
   bash Copy

   unzip resume.zip -d resume-app
   cd resume-app

2. Run the Deployment Script
   bash Copy

   chmod +x deploy.sh
   ./deploy.sh

   ✅

   This script will:

   • Install Docker and Docker Compose (if not installed)
   • Build and start the containers
   • Automatically set up SSL certificates if a valid domain is provided in .env
3. Verify
   • Use docker-compose logs -f to monitor the startup process.
   • Open your domain in a browser to confirm everything is working.