felfire
One bolt of powerful magic to improves your development workflow
Last updated 3 years ago by nicolascava .
Original npm · Tarball · package.json
$ cnpm install felfire 
SYNC missed versions from official npm registry.

Felfire Logo

Felfire

CircleCI

One bolt of powerful magic to improves your web app workflow.

Felfire is a full-featured and opinionated tooling library. It's mainly focused on improving developer experience (DX) on React-based applications. No more JavaScript fatigue. Just focus to build your product, don't worry about your tooling stack!

Philosophy

  • Single-dependency: [...]
  • Opinionated: [...]
  • Deployment pipeline support: [...]

Features

  • React stack based: [...]
  • Live-reload and hot reloading: [...]
  • Universal JavaScript support: [...]
  • CSS modules: [...]
  • Deployment: [...]

Quick Start

Let's start by create a new Node.js project. Felfire works great with the following boilerplate: mapleinside/web-app-boilerplate.

However, if you want to start from scratch, Felfire is opinionated by nature, so you should follow Maple Inside's architecture conventions in order to use it. When you're ready to go, install Felfire as local dependency:

npm i felfire --save-dev

Write the configuration's file felfire.yml (see Customization for more information). And finally, start the development server:

felfire start

./src is the main source directory. Start write code here!

Commands

For best use, commands should be defined into the package.json as NPM scripts.

  • felfire start: spin up a development server with live-reload and HMR;
  • felfire build: build a production-ready version of the app;
  • felfire deploy:static: deploy your app static resources to the specified AWS S3 bucket;
  • felfire deploy:eb: deploy your app using CircleCI, Docker and AWS Elastic Beanstalk.

Commands arguments

  • -e or --env-file: use another .env file instead of ./env/dev.env. Useful to build a production-ready version of the app for the staging or production environment (e.q. --env-file=./env/staging.env);
  • -n or --eb-env: felfire deploy:eb needs an AWS environment name in order to deploy to the right environment (e.q. --eb-env=my-felfire-app-staging).

How Felfire Works

[...]

Felfire Flow

Customization

Felfire uses a YAML file named felfire.yml as configuration. You can easily custom many options here. Below these are the mandatory options:

aws:
  region: us-west-2
  eb:
    app: my-felfire-app
  s3:
    eb:
      bucket: elasticbeanstalk-us-west-2-123456789
docker:
  image: felfire/my-felfire-app
env:
  secret:
    - AWS_ACCESS_KEY_ID
    - AWS_SECRET_ACCESS_KEY
    - NPM_TOKEN
    - NEW_RELIC_LICENSE_KEY

Options

Here the full customizable options for Felfire:

aws:
  region: us-west-2
  eb:
    app: my-felfire-app
  s3:
    eb:
      bucket: elasticbeanstalk-us-west-2-123456789
docker:
  image: felfire/my-felfire-app
env:
  secret:
    - AWS_ACCESS_KEY_ID
    - AWS_SECRET_ACCESS_KEY
    - NPM_TOKEN
    - NEW_RELIC_LICENSE_KEY

License

(The MIT License)

Copyright (c) 2016 Maple Inside

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Current Tags

  • 4.0.0                                ...           latest (3 years ago)
  • 4.0.0                                ...           lerna-temp (3 years ago)

67 Versions

  • 4.0.0                                ...           3 years ago
  • 3.1.0                                ...           3 years ago
  • 3.0.0                                ...           3 years ago
  • 2.0.0                                ...           3 years ago
  • 1.0.0-alpha.65                                ...           3 years ago
  • 1.0.0-alpha.64                                ...           3 years ago
  • 1.0.0-alpha.63                                ...           3 years ago
  • 1.0.0-alpha.62                                ...           3 years ago
  • 1.0.0-alpha.61                                ...           3 years ago
  • 1.0.0-alpha.60                                ...           3 years ago
  • 1.0.0-alpha.59                                ...           3 years ago
  • 1.0.0-alpha.58                                ...           3 years ago
  • 1.0.0-alpha.57                                ...           3 years ago
  • 1.0.0-alpha.56                                ...           3 years ago
  • 1.0.0-alpha.55                                ...           3 years ago
  • 1.0.0-alpha.54                                ...           3 years ago
  • 1.0.0-alpha.53                                ...           3 years ago
  • 1.0.0-alpha.52                                ...           3 years ago
  • 1.0.0-alpha.51                                ...           3 years ago
  • 1.0.0-alpha.50                                ...           3 years ago
  • 1.0.0-alpha.49                                ...           3 years ago
  • 1.0.0-alpha.48                                ...           3 years ago
  • 1.0.0-alpha.47                                ...           3 years ago
  • 1.0.0-alpha.46                                ...           3 years ago
  • 1.0.0-alpha.45                                ...           3 years ago
  • 1.0.0-alpha.44                                ...           3 years ago
  • 1.0.0-alpha.43                                ...           3 years ago
  • 1.0.0-alpha.42                                ...           3 years ago
  • 1.0.0-alpha.41                                ...           3 years ago
  • 1.0.0-alpha.40                                ...           3 years ago
  • 1.0.0-alpha.39                                ...           3 years ago
  • 1.0.0-alpha.38                                ...           3 years ago
  • 1.0.0-alpha.37                                ...           3 years ago
  • 1.0.0-alpha.35                                ...           3 years ago
  • 1.0.0-alpha.34                                ...           3 years ago
  • 1.0.0-alpha.33                                ...           3 years ago
  • 1.0.0-alpha.31                                ...           3 years ago
  • 1.0.0-alpha.30                                ...           3 years ago
  • 1.0.0-alpha.29                                ...           4 years ago
  • 1.0.0-alpha.28                                ...           4 years ago
  • 1.0.0-alpha.27                                ...           4 years ago
  • 1.0.0-alpha.26                                ...           4 years ago
  • 1.0.0-alpha.25                                ...           4 years ago
  • 1.0.0-alpha.24                                ...           4 years ago
  • 1.0.0-alpha.23                                ...           4 years ago
  • 1.0.0-alpha.22                                ...           4 years ago
  • 1.0.0-alpha.21                                ...           4 years ago
  • 1.0.0-alpha.20                                ...           4 years ago
  • 1.0.0-alpha.19                                ...           4 years ago
  • 1.0.0-alpha.18                                ...           4 years ago
  • 1.0.0-alpha.17                                ...           4 years ago
  • 1.0.0-alpha.16                                ...           4 years ago
  • 1.0.0-alpha.15                                ...           4 years ago
  • 1.0.0-alpha.14                                ...           4 years ago
  • 1.0.0-alpha.13                                ...           4 years ago
  • 1.0.0-alpha.12                                ...           4 years ago
  • 1.0.0-alpha.11                                ...           4 years ago
  • 1.0.0-alpha10                                ...           4 years ago
  • 1.0.0-alpha9                                ...           4 years ago
  • 1.0.0-alpha8                                ...           4 years ago
  • 1.0.0-alpha7                                ...           4 years ago
  • 1.0.0-alpha6                                ...           4 years ago
  • 1.0.0-alpha5                                ...           4 years ago
  • 1.0.0-alpha4                                ...           4 years ago
  • 1.0.0-alpha3                                ...           4 years ago
  • 1.0.0-alpha2                                ...           4 years ago
  • 1.0.0-alpha1                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 4
Last Day 0
Last Week 2
Last Month 4
Dev Dependencies (4)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |