Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
VITE_FIREBASE_API_KEY=
VITE_FIREBASE_AUTH_DOMAIN=
VITE_FIREBASE_PROJECT_ID=
VITE_FIREBASE_STORAGE_BUCKET=
VITE_FIREBASE_MESSAGING_SENDER_ID=
VITE_FIREBASE_APP_ID=
VITE_FIREBASE_MEASUREMENT_ID=
12 changes: 12 additions & 0 deletions .github/workflows/pages-release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- master
- main
workflow_dispatch:

permissions:
Expand All @@ -18,6 +22,14 @@ jobs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
env:
GITHUB_PAGES: "true"
VITE_FIREBASE_API_KEY: ${{ secrets.VITE_FIREBASE_API_KEY }}
VITE_FIREBASE_AUTH_DOMAIN: ${{ secrets.VITE_FIREBASE_AUTH_DOMAIN }}
VITE_FIREBASE_PROJECT_ID: ${{ secrets.VITE_FIREBASE_PROJECT_ID }}
VITE_FIREBASE_STORAGE_BUCKET: ${{ secrets.VITE_FIREBASE_STORAGE_BUCKET }}
VITE_FIREBASE_MESSAGING_SENDER_ID: ${{ secrets.VITE_FIREBASE_MESSAGING_SENDER_ID }}
VITE_FIREBASE_APP_ID: ${{ secrets.VITE_FIREBASE_APP_ID }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
Expand Down
52 changes: 52 additions & 0 deletions docs/FIREBASE_SETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Firebase Setup (GitHub Pages)

## 1) Create Firebase project

1. Open Firebase Console and create/select your project.
2. Add a **Web App**.
3. Copy the Firebase config values.

## 2) Enable authentication

1. Firebase Console → Authentication → Sign-in method.
2. Enable **Google** provider.
3. Add authorized domains:
- `localhost`
- `<your-github-username>.github.io`

## 3) Enable Firestore

1. Firebase Console → Firestore Database → Create database.
2. Start in production mode.
3. Use these security rules:

```txt
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /users/{userId}/contractions/{docId} {
allow read, write: if request.auth != null && request.auth.uid == userId;
}
}
}
```

## 4) Local development config

1. Copy `.env.example` to `.env`.
2. Paste your Firebase config values.
3. Run `npm run dev`.

## 5) GitHub Pages secrets

In GitHub repo settings, add Actions secrets:

- `VITE_FIREBASE_API_KEY`
- `VITE_FIREBASE_AUTH_DOMAIN`
- `VITE_FIREBASE_PROJECT_ID`
- `VITE_FIREBASE_STORAGE_BUCKET`
- `VITE_FIREBASE_MESSAGING_SENDER_ID`
- `VITE_FIREBASE_APP_ID`
- `VITE_FIREBASE_MEASUREMENT_ID` (optional)

The Pages workflow injects these at build time.
Loading