Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/firelayer/starter-template
Firelayer Template - Starter (default template)
https://github.com/firelayer/starter-template
administration-dashboard boilerplate cloud-functions dashboard firebase firelayer template vue vuetify
Last synced: about 2 months ago
JSON representation
Firelayer Template - Starter (default template)
- Host: GitHub
- URL: https://github.com/firelayer/starter-template
- Owner: firelayer
- License: mit
- Created: 2020-04-26T18:27:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-08T14:16:40.000Z (over 3 years ago)
- Last Synced: 2024-05-20T17:23:45.531Z (7 months ago)
- Topics: administration-dashboard, boilerplate, cloud-functions, dashboard, firebase, firelayer, template, vue, vuetify
- Language: Vue
- Homepage: https://firelayer-starter-template.web.app
- Size: 3.46 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Firelayer Documentation
[Documentation Website](https://firelayer.io/docs)
## Installation Guide
You can use an existing Firebase project or create a new project on the [Firebase Console](https://console.firebase.google.com).
Follow the guide on preparing a Firebase project for Firelayer
**[Setting up Firebase - Guide](https://firelayer.io/docs/setting-up-firebase)**
#### Starting in a new project
```sh
firelayer init new-project -t starter
```
#### Adding to a current firelayer project
```sh
firelayer add:template starter
```
### Adding a landing page to this template
If you wish to add a landing website. You can do so by adding the landing template:
```sh
firelayer add:template landing
```
### Quick Start
> After Install
To start run **`yarn dev`** or **`npm run dev`** and the three applications should be ready on:
- Admin - http://localhost:8081
- Functions - http://localhost:5000/api/api
> ports may change if already in use by other services
### Adding an Administrator
1. Follow the steps on [Getting Started to add a Service Account key](https://firelayer.io/docs/getting-started#get-the-firebase-service-account-key) to your project so you can run Firelayer CLI helpers.
2. If you don't have any users on this Firebase Project you can always create a new one using the firelayer CLI or on the Firebase Console.
`firelayer auth:add -u [email protected] -p password123`
3. Add Administration privileges to user:
`firelayer auth -u [email protected] --set-admin`
And now you can login on the administration dashboard - http://localhost:8081
## Content
#### [`apps/functions` Cloud Functions](/apps/functions/README.md)
- Express API
- User management
- Triggers examples
- Scheduled jobs examples
#### [`apps/admin` Administration Dashboard](/apps/admin/README.md)
- Firebase Users Management
- Send auth emails with SendGrid
- Vue & Vuetify Components
## Development
Starter template is organized as a monorepo using [Lerna](https://lerna.js.org/) and yarn workspaces. Useful scripts include:
#### `yarn bootstrap`
> Installs package dependencies and links packages together - using lerna and yarn workspaces
#### `yarn build`
> Cleans the previous builds and starts building on all sub packages - using lerna run build
#### `yarn dev`
> Starts the dev mode on all sub packages - using lerna run dev
## License
Firelayer is open-sourced software licensed under the [MIT license](https://github.com/firelayer/firelayer/blob/master/LICENSE).