-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,49 @@ | ||
# Turborepo + Firebase | ||
# Turborepo Firebase starter | ||
|
||
This is an unofficial starter Turborepo. | ||
|
||
## Using this example | ||
|
||
How to combine turborepo and firebase to have idempotent deployments from local and CI. | ||
|
||
## What's inside? | ||
|
||
This Turborepo includes the following packages/apps: | ||
|
||
### Apps and packages | ||
|
||
``` | ||
βββ apps | ||
β βββ api # firebase function that is typescript and loaded as ESM and deployed as a firebase function | ||
β βββ web # the react+vite front end deployed to firebase hosting | ||
``` | ||
|
||
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). | ||
|
||
### Prerequisites | ||
|
||
- [Node.js](https://nodejs.org/en/download/) | ||
- [pnpm](https://pnpm.io/installation) | ||
- [Firebase CLI](https://firebase.google.com/docs/cli) | ||
- A [Firebase project](https://firebase.google.com/docs/projects/create) | ||
|
||
### Setup | ||
|
||
1. Edit `.firebaserc` and add your project's id | ||
2. Install dependencies | ||
|
||
```sh | ||
pnpm i | ||
``` | ||
|
||
### Develop | ||
|
||
```sh | ||
pnpm start | ||
``` | ||
# install the deps | ||
npm install | ||
|
||
# to develop | ||
npm start | ||
### Deploy | ||
|
||
# to deploy | ||
npm run deploy | ||
```sh | ||
pnpm deploy | ||
``` |