Skip to content

Commit

Permalink
docs: edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
yamcodes committed Mar 30, 2024
1 parent 3ab049f commit 8f8fe60
Showing 1 changed file with 36 additions and 7 deletions.
43 changes: 36 additions & 7 deletions README.md
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
```

0 comments on commit 8f8fe60

Please sign in to comment.