Lara-Fire — Laravel 后台模板

SHA-256: 485e522efce5cea03222aa033b198bb6711b86b8b1e9352f0a7df22ccb3488f2

2026-10-01T02:26:26.731Z

<p align="center"><img src="https://img.shields.io/badge/Laravel-13-FF2D20?logo=laravel&logoColor=white" alt="Laravel 13"> <img src="https://img.shields.io/badge/Firebase-Auth%20%C2%B7%20Firestore%20%C2%B7%20FCM-FFCA28?logo=firebase&logoColor=black" alt="Firebase"> <img src="https://img.shields.io/badge/PHP-8.3%2B-777BB4?logo=php&logoColor=white" alt="PHP 8.3+"></p>

# 🔥 Lara Fire

[![Latest Stable Version](https://poser.pugx.org/suhasrkms/lara-fire/v/stable)](https://packagist.org/packages/suhasrkms/lara-fire)
[![Total Downloads](https://poser.pugx.org/suhasrkms/lara-fire/downloads)](https://packagist.org/packages/suhasrkms/lara-fire)
[![tests](https://github.com/suhasrkms/Lara-Fire/actions/workflows/tests.yml/badge.svg)](https://github.com/suhasrkms/Lara-Fire/actions/workflows/tests.yml)
[![License: MIT](https://img.shields.io/github/license/suhasrkms/lara-fire)](LICENSE.md)
[![Docs](https://img.shields.io/badge/docs-lara--fire-FFC107?logo=readthedocs&logoColor=black)](https://suhasrkms.github.io/lara-fire-docs.html)

**[📖 Documentation](https://suhasrkms.github.io/lara-fire-docs.html)** · [Installation](https://suhasrkms.github.io/lara-fire-docs.html#installation) · [Firebase setup](https://suhasrkms.github.io/lara-fire-docs.html#firebase-setup) · [REST API](https://suhasrkms.github.io/lara-fire-docs.html#api) · [Troubleshooting](https://suhasrkms.github.io/lara-fire-docs.html#troubleshooting) · [▶ Videos](https://www.youtube.com/@sevenstac)

**A Laravel 13 + Firebase starter kit.** Firebase Authentication, an admin panel driven by custom claims, Cloud Firestore CRUD, push notifications and a REST API that accepts Firebase ID tokens. No SQL database is needed.

| | Feature |
|---|---|
| 🔐 | Email/password, **Google** and **GitHub** sign-in, email verification, password reset |
| 🛡️ | **Admin panel**: search, stats, grant/revoke admin, enable/disable users, send reset links |
| 🗂️ | **Cloud Firestore** Notes module: per-user CRUD over REST, with no gRPC needed |
| 🔔 | **FCM push**: users opt in per browser, and admins broadcast or target one user |
| 🔌 | **REST API** `/api/v1` authenticated with `Authorization: Bearer <Firebase ID token>` |
| 🌙 | Bootstrap 5.3 UI with dark mode, built with Vite 8 |

![Lara Fire admin panel](.github/screenshots/admin-dark.png)

<p align="center"><img src=".github/screenshots/login.png" width="32%" alt="Login"> <img src=".github/screenshots/dashboard.png" width="32%" alt="Dashboard"> <img src=".github/screenshots/notes.png" width="32%" alt="Firestore notes"></p>

## 📖 Documentation

The full docs are at **[suhasrkms.github.io/lara-fire-docs.html](https://suhasrkms.github.io/lara-fire-docs.html)**.

| Getting started | Features | Guides |
|---|---|---|
| [Requirements](https://suhasrkms.github.io/lara-fire-docs.html#requirements) | [Authentication](https://suhasrkms.github.io/lara-fire-docs.html#authentication) | [How it works](https://suhasrkms.github.io/lara-fire-docs.html#architecture) |
| [Installation](https://suhasrkms.github.io/lara-fire-docs.html#installation) | [Google & GitHub login](https://suhasrkms.github.io/lara-fire-docs.html#social-login) | [Customizing](https://suhasrkms.github.io/lara-fire-docs.html#customizing) |
| [Firebase setup](https://suhasrkms.github.io/lara-fire-docs.html#firebase-setup) | [Admin panel & roles](https://suhasrkms.github.io/lara-fire-docs.html#admin) | [Testing](https://suhasrkms.github.io/lara-fire-docs.html#testing) |
| [Configuration (.env)](https://suhasrkms.github.io/lara-fire-docs.html#configuration) | [Cloud Firestore](https://suhasrkms.github.io/lara-fire-docs.html#firestore) | [Deployment](https://suhasrkms.github.io/lara-fire-docs.html#deployment) |
| [Running the app](https://suhasrkms.github.io/lara-fire-docs.html#running) | [Push notifications](https://suhasrkms.github.io/lara-fire-docs.html#push) | [Troubleshooting](https://suhasrkms.github.io/lara-fire-docs.html#troubleshooting) |
| [Upgrading from v1](https://suhasrkms.github.io/lara-fire-docs.html#upgrading) | [REST API](https://suhasrkms.github.io/lara-fire-docs.html#api) | [FAQ](https://suhasrkms.github.io/lara-fire-docs.html#faq) |

## Quick start

```bash
composer create-project suhasrkms/lara-fire my-app
cd my-app
npm install && npm run build
```

1. **Service account:** open Firebase console → Project settings → Service accounts → *Generate new private key*. Save the file as `storage/app/firebase/service-account.json`. It is git-ignored.
2. **Web config:** under Project settings → General → Your apps → Web, copy the values into the `FIREBASE_WEB_*` keys in `.env`.
3. **Sign-in methods:** under Authentication → Sign-in method, enable *Email/Password* plus *Google* and/or *GitHub*. Add your domain under *Authorized domains*.
4. Run it:

```bash
php artisan serve          # or: composer dev  (server + logs + vite)
php artisan larafire:about # checks your setup
```

5. Register an account, then give yourself admin rights from the terminal:

```bash
php artisan larafire:make-admin [email protected]
```

## Optional features

### Push notifications (FCM)
Generate a key pair under Project settings → Cloud Messaging → *Web Push certificates* and set `FIREBASE_WEB_VAPID_KEY`. Users click **Enable on this device** on the dashboard. Admins send messages from **Admin → Push notifications**. The app uses topics (`larafire-all`, `larafire-user-<uid>`), so tokens don't need to be stored.

### Cloud Firestore
Notes use Firestore's REST API with your service account. You don't need the `grpc` extension or any extra package, and it works on Windows as-is. Create the database in Firebase console → **Firestore Database** → *Create database*. Notes are stored in `notes/{id}` as `{ uid, title, body, created_at, updated_at }`. Suggested security rules if you also read Firestore from clients:

```
match /notes/{id} {
  allow read, write: if request.auth != null && request.auth.uid == resource.data.uid;
}
```

## REST API

Get an ID token on the client (`await auth.currentUser.getIdToken()`) and send it as a bearer token:

```bash
curl http://localhost:8000/api/v1/me -H "Authorization: Bearer $ID_TOKEN"
```

| Method | Endpoint | Auth |
|---|---|---|
| GET | `/api/v1/me` | ID token |
| GET / POST | `/api/v1/notes` | ID token |
| GET / PUT / DELETE | `/api/v1/notes/{id}` | ID token |

## Commands

| Command | What it does |
|---|---|
| `larafire:make-admin {email} [--revoke]` | Grant or revoke the `admin` custom claim |
| `larafire:about` | Show setup status and next steps |

## Upgrading from v1

v2 is a rewrite on Laravel 13. Your Firebase users and claims carry over unchanged.
- Move your key to `storage/app/firebase/service-account.json` and update `FIREBASE_CREDENTIALS`.
- The `/home/iamadmin` route has been **removed** because any user could promote themselves. Use `php artisan larafire:make-admin`.
- See [CHANGELOG.md](CHANGELOG.md) for everything else.

## Testing

```bash
composer test   # Firebase is mocked, so no credentials are needed
```

## 📺 Video tutorials

Walkthroughs for this project are on [Seven Stac](https://www.youtube.com/@sevenstac).

## Contributing

Issues and PRs are welcome. Please run `composer lint` and `composer test` before opening a PR.

## License

MIT © [Suhas R](https://suhasrkms.github.io)

---

<p align="center">Made with ❤️ by <a href="https://github.com/suhasrkms">suhasrkms</a></p>