orchetera/README.md

Welcome to **Orchetera** — your orchestration tool to kickstart Firebase-ready projects with ease!

# 🎼 Orchetera CLI Quickstart

Welcome to **Orchetera** — your orchestration tool to kickstart Firebase-ready projects with ease!

---

## 🚀 Getting Started

1. **Run Orchetera**
   ```bash
   npx orchetera [your-project-directory]
   ```

2. **🔧 Setup Firebase Config**
   Make sure `../firebaseConfig.js` exists and is properly filled.  
   If it doesn’t, complete it manually like so:
   ```js
   // ../firebaseConfig.js
   export const firebaseConfig = {
     apiKey: "YOUR_API_KEY",
     authDomain: "YOUR_PROJECT_ID.firebaseapp.com",
     projectId: "YOUR_PROJECT_ID",
     storageBucket: "YOUR_PROJECT_ID.appspot.com",
     messagingSenderId: "SENDER_ID",
     appId: "APP_ID"
   };
   ```

3. **⏳ Let Orchetera Handle the Setup**  
   Sit back while Orchetera installs all required dependencies for you. 🧙‍♂️

---

## 🔥 Firebase Console Setup

Go to [Firebase Console](https://console.firebase.google.com/) and do the following:

- ✅ **Activate Hosting**  
  ⚠️ *Select regular Hosting, not App Hosting.*

- ✅ **Enable Authentication**  
  Use the **Email/Password** provider.

- ✅ **Create Firestore Database**  
  Choose production mode or test mode.

---

## 🛡️ Firestore Security Rules

> Replace the default rules with:

```js
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}
```

---

## 📁 Directory Generated

Example structure:
```
/your-project-directory
├── /src
├── firebaseConfig.js ✅
├── .env
└── ...
```

---

## 🔐 Environment Config (.env)

- ✅ `.env` file will be **automatically generated**.
- ✅ An **encrypted version** of `.env` will also be created for safe transfer across devices.
- 🔁 When switching devices, just **decrypt it**, and... boom! You're ready to run.
- 🔑 During env generation, a **password will appear in the CLI** — **copy and save it** securely.

### 🔄 Update or Decrypt .env

- To **re-encrypt** after modifying `.env`:
  ```bash
  npx dechipera
  ```

- To **manually decrypt** on another machine:
  ```bash
  npx dechipera --dec
  ```

---

## 🌐 GitHub + Auto Deployment Setup

Once Orchetera finishes its setup:

1. ✅ **Create a GitHub Repository**  
   Push your project to the repo.

2. ✅ **Add GitHub Variable (not secret)**  
   - Name: `DECHIPERA_TOKEN`  
   - Value: (Paste the **decryption password** from the CLI)

3. ✅ **Add GitHub Secret**  
   - Name: `FIREBASE_SERVICE_ACCOUNT`  
   - Value:  
     - Go to **Firebase Console** → Project Settings → **Service Accounts**  
     - Click **"Generate new private key"**  
     - Copy entire JSON content and use it as the secret value

4. ✅ **Commit and Push**  
   Once pushed, deployment will be triggered **automatically** 🎉  
   The version will follow **semantic versioning (semver)** automatically.

5. ✅ **Open Your Firebase Hosting URL**  
   Boom 💥 — your website is **live and accessible online**!

---

## 💻 Local Environment Experience

After Orchetera setup is done:

- ✅ **VS Code** will automatically open the newly created project folder
- ✅ A browser tab will open pointing to the **auto-generated local port**
  (no port conflict — each project uses a random, safe port)

Now you can **code, push, and boom!**  
Build your app as easily as flipping your hand ✋😉

---

## ❤️ Powered by Orchetera

> "Let the tools play the symphony for you."