Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/firelayer/firelayer

Firelayer - Jump-start your Firebase Web Project
https://github.com/firelayer/firelayer

boilerplate cli firebase firelayer framework scaffold starter template toolkit

Last synced: 2 months ago
JSON representation

Firelayer - Jump-start your Firebase Web Project

Awesome Lists containing this project

README

        



Firelayer

Jump-start your Firebase Web Project




Build Status on Github


Version


License

Firelayer is a boilerplate toolkit for Firebase web projects.
It allows you to jump-start your Firebase web projects with templates for common use cases so you don't have to start from scratch.

### Documentation

[Documentation Website](https://firelayer.io)

## Table of contents

- 🚀[ Getting Started](#getting-started)
- 👥 [Community](#community)
- 👨‍💻 [Development](#development)
- :memo: [License](#license)

## Getting Started

Install firelayer globally:

```sh
npm i -g @firelayer/cli
```

And initialize a new project:
```sh
firelayer init new-project
```

Once it's installed, you can `cd new-project` and `npm run dev` or `yarn dev` and it will run the development servers on your local machine.

Start with other templates
- [https://firelayer.io/templates](https://firelayer.io/templates)

## Community

- Blogging at [Medium](https://medium.com/firelayer)

## Development

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