Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/firelayer/board-template

Firelayer Template - Suggestion Board (Realtime Database)
https://github.com/firelayer/board-template

boilerplate firebase firelayer realtime template vue vuetify

Last synced: about 1 month ago
JSON representation

Firelayer Template - Suggestion Board (Realtime Database)

Awesome Lists containing this project

README

        


Firelayer

> https://board.firelayer.io


### 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 board
```

#### Adding to a current firelayer project
```sh
firelayer add:template board
```

### Quick Start
> After Install

To start run **`yarn dev`** or **`npm run dev`** and the three applications should be ready on:
- board - http://localhost:8082
> ports may change if already in use by other services

## Content

#### [`apps/board` Board](/apps/board/README.md)
- Suggestion Board for Realtime Database
- Vue & Vuetify Components

## Development

Board 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).