mirror of
https://github.com/terribleplan/next.js.git
synced 2024-01-19 02:48:18 +00:00
64 lines
2.6 KiB
Markdown
64 lines
2.6 KiB
Markdown
# With Firebase Hosting and Docker example
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-firebase-hosting-and-docker with-firebase-hosting-and-docker-app
|
|
# or
|
|
yarn create next-app --example with-firebase-hosting-and-docker with-firebase-hosting-and-docker-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example:
|
|
|
|
```bash
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-firebase-hosting-and-docker
|
|
cd with-firebase-hosting-and-docker
|
|
```
|
|
|
|
Set up firebase:
|
|
|
|
* create a project through the [firebase web console](https://console.firebase.google.com/)
|
|
* grab the projects ID from the web consoles URL: https://console.firebase.google.com/project/<projectId>
|
|
* update the `.env` with your FB_PROJECTID and FIREBASE_TOKEN ( see .env.example )
|
|
* ADD `serviceAccountKey.json` to your project root
|
|
|
|
### Dev next
|
|
|
|
```bash
|
|
yarn docker:dev
|
|
open http://localhost:5000
|
|
```
|
|
|
|
### Firebase serve
|
|
|
|
```bash
|
|
yarn docker:serve
|
|
open http://localhost:3000
|
|
```
|
|
|
|
### Firebase deploy
|
|
|
|
```bash
|
|
yarn docker:deploy
|
|
```
|
|
|
|
## The idea behind the example
|
|
|
|
The goal is to host the Next.js app on Firebase Cloud Functions with Firebase Hosting rewrite rules so our app is served from our Firebase Hosting URL, with docker support for a consistent development environment. Each individual `page` bundle is served in a new call to the Cloud Function which performs the initial server render. Docker is entirely dedicated for local development and the deployment process and that Firebase itself will not leverage Docker itself.
|
|
|
|
This is based off of the work of @jthegedus in the [with-firebase-hosting](https://github.com/zeit/next.js/tree/canary/examples/with-firebase-hosting) example.
|
|
|
|
If you're having issues, feel free to tag @sampsonjoliver in the [issue you create on the next.js repo](https://github.com/zeit/next.js/issues/new)
|
|
|
|
## Important
|
|
|
|
* The empty `placeholder.html` file is so Firebase Hosting does not error on an empty `public/` folder and still hosts at the Firebase project URL.
|
|
* `firebase.json` outlines the catchall rewrite rule for our Cloud Function.
|
|
* The [Firebase predeploy](https://firebase.google.com/docs/cli/#predeploy_and_postdeploy_hooks) hooks defined in `firebase.json` will handle linting and compiling of the next app and the functions sourceswhen `firebase deploy` is invoked. The only scripts you should need are `docker:dev`, `docker:serve` and `docker:deploy`.
|