Temp Number Deployment

Deployment automation and configuration for the Temp Number application stack.

Stack: AdonisJS Backend • Vue.js Frontend • MySQL Database

---

🚀 Quick Start

New to this project? Run the interactive setup wizard:

./setup-wizard.sh

This guided wizard will:

• ✅ Help you choose between local Docker or Google Cloud deployment
• ✅ Set up Firebase authentication (required)
• ✅ Configure GCP project (if deploying to cloud)
• ✅ Clone source code repositories (if needed)
• ✅ Create and validate configuration files
• ✅ Deploy your application automatically

Perfect for first-time setup! The wizard handles all the complexity for you.

🧙 Setup Wizard Guide - First-time setup walkthrough

Note for Windows users: All bash scripts work seamlessly in WSL (Windows Subsystem for Linux). See the Windows WSL Setup Guide for detailed instructions.

---

📋 Manual Deployment Options

Already configured? Use these direct deployment methods:

Option 1: Local Development (Docker Compose)

Run the entire stack locally for development and testing.

# Start all services (from project root)
./docker-start.sh

Access:

• Web: http://localhost:8080
• API: http://localhost:3333

📖 Full guide: Docker Compose Local Testing

---

Option 2: Google Cloud Run (Production)

Deploy to Google Cloud Platform with automated setup.

# Interactive deployment (from project root)
./google-cloud-deploy.sh

The script handles:

• CloudSQL database setup
• Backend API deployment
• Web frontend deployment
• Database migrations
• Secret management

📖 Full guide: Complete Deployment Guide
📋 Quick reference: Common Commands

---

🔧 What You Need (Manual Setup)

If you prefer manual configuration over the setup wizard, you'll need:

1. Prerequisites

For Local Docker:

• Docker and Docker Compose installed

For Google Cloud:

• gcloud CLI (Google Cloud SDK) installed and authenticated
• GCP project with billing enabled

2. Configuration Files

The setup wizard creates these automatically, or you can create them manually:

# Copy templates
cp config/env/backend.env.example config/env/backend.env
cp config/env/web.env.example config/env/web.env
cp config/secrets/backend.secrets.example config/secrets/backend.secrets

# Edit with your values
nano config/env/backend.env
nano config/env/web.env
nano config/secrets/backend.secrets

What you need:

• config/env/backend.env - Database, server settings
• config/env/web.env - Firebase config, web settings
• config/secrets/backend.secrets - API keys, passwords, tokens, etc.

3. Service Account Keys

Firebase Admin SDK:

• Download from Firebase Console → Project Settings → Service Accounts
• Save as: config/secrets/firebase-service-account.json

GCP Service Account (for cloud deployment only):

• Create in GCP Console → IAM & Admin → Service Accounts
• Save as: config/cloud-providers/gcp-service-account.json

📖 Detailed setup guide: Configuration Guide

4. Source Code

Clone backend and web repositories to the root of this project manually:

git clone https://github.com/platfone-com/temp-number-backend.git
git clone https://github.com/platfone-com/temp-number-web.git

---

🎯 Recommended Workflow

First Time Setup

1. Run ./setup-wizard.sh (easiest!)
2. Let the wizard guide you through all steps
3. Deploy automatically when prompted

Subsequent Deployments

• Local: ./docker-start.sh
• Cloud: ./google-cloud-deploy.sh

Advanced Users

Use individual scripts in scripts/gcp/ for granular control:

• setup_gcp_project.sh - GCP project setup
• setup_firebase_project.sh - Firebase configuration
• create_sql_instance.sh - Database setup
• deploy_backend.sh - Backend deployment
• deploy_web.sh - Frontend deployment

---

🔐 Security

Never commit these files:

• ❌ config/cloud-providers/gcp-service-account.json
• ❌ config/secrets/firebase-service-account.json
• ❌ config/secrets/backend.secrets
• ❌ config/env/backend.env
• ❌ config/env/web.env

They are already in .gitignore for your protection.

---

📁 Project Structure

temp-number-deploy/
├── setup-wizard.sh                  # 🧙 Setup wizard wrapper (START HERE!)
├── docker-start.sh                  # 🐳 Docker deployment wrapper
├── google-cloud-deploy.sh           # ☁️ GCP deployment wrapper
│
├── scripts/
│   ├── setup_wizard.sh              # Interactive setup wizard (actual script)
│   ├── common/                      # Common helper functions
│   │   └── helpers.sh
│   ├── docker/                      # Docker Compose files
│   │   ├── docker-compose.yml
│   │   └── docker-start.sh          # Start all services locally (actual script)
│   └── gcp/                         # GCP deployment scripts
│       ├── setup_gcp_project.sh     # GCP project setup helper
│       ├── setup_firebase_project.sh # Firebase setup helper
│       └── deploy_app.sh            # Google Cloud deployment (actual script)
│
├── config/
│   ├── env/                         # Environment configuration (git-ignored)
│   │   ├── backend.env              # Backend settings
│   │   └── web.env                  # Web frontend settings
│   ├── secrets/                     # Sensitive data (git-ignored)
│   │   ├── backend.secrets          # API keys, passwords
│   │   └── firebase-service-account.json
│   └── cloud-providers/             # Cloud credentials (git-ignored)
│       └── gcp-service-account.json
│
├── docs/                            # Documentation
│   ├── SETUP_WIZARD.md              # 🧙 Setup wizard guide
│   ├── WINDOWS_WSL_GUIDE.md         # 🪟 Windows WSL setup guide
│   └── docker/
│   │   └── DOCKER_COMPOSE_LOCAL.md
│   └── gcp/
│       ├── DEPLOYMENT.md
│       └── QUICK_REFERENCE.md
│
├── temp-number-backend/             # Backend project (git cloned from repo)
├── temp-number-web/                 # Frontend project (git cloned from repo)
│
├── setup-wizard.sh                  # Wrapper script for setup wizard
├── docker-start.sh                  # Wrapper script for Docker deployment
└── google-cloud-deploy.sh           # Wrapper script for GCP deployment

---

📖 Documentation

• 🧙 Setup Wizard Guide - First-time setup walkthrough
• 🐳 Docker Compose Local Environment
• ☁️ Google Cloud Deployment Guide
• 📋 Google Cloud Quick Reference
• 🪟 Windows WSL Setup Guide

Note for Windows users: All bash scripts work seamlessly in WSL (Windows Subsystem for Linux). See the Windows WSL Setup Guide for detailed instructions.

---

🆘 Troubleshooting

Setup wizard fails?

• Make sure you have gcloud installed and authenticated
• Check that Docker is running (for local deployment)
• Verify billing is enabled on your GCP project (for cloud deployment)

Need help?

• See Troubleshooting Guide
• Check individual script documentation in docs/
• Open an issue in this repository

---

📝 License

MIT with restrictions on API usage. See LICENSE for details.

---

🛠️ Support

For issues or questions:

• Getting Started: Run ./setup-wizard.sh for guided setup
• Documentation: Check the guides in the docs/ folder
• Bugs: Open an issue in this repository
• Cloud Deployment: See Troubleshooting Guide