Getting StartedEdit this page
# System Requirements
# Keep in mind:
- You can use an existing Firebase project or create a new project on Firebase Console
Follow the guide on preparing a Firebase project for Firelayer
We recommend creating a new Firelayer project using
@firelayer/cli, which does the initial project setup automatically for you. To get the CLI, run:
npm i -g @firelayer/cli
# Create a new project
With the following command, firelayer will copy the boilerplate and install its dependencies.
firelayer init new-project
# Change directories into project folder
# Get the Firebase Service Account key
In order to use the Admin SDK in our Firebase Cloud Functions a service account key is needed. More information here.
To generate a private key file for your service account:
- In the Firebase console, open Settings > Service Accounts.
- Click Generate New Private Key, then confirm by clicking Generate Key.
- Securely store the JSON file in the folder
- Rename the key file to
key.json(replace the default
key.jsonfile if it exists)
- Check if the path is correct:
config/keys/key.jsonImportant! Do not share or distribute this key, it must remain private.
# Start the development servers
yarn dev # or for npm npm run dev
# Create a production build
yarn build # or for npm npm run build
# Deploy into Firebase
yarn deploy # or for npm npm run deploy