Node Express Firebase Stack generator
Yeoman generator for creating FEN stack applications, using Firebase, Express, and Node - lets you quickly set up a project following best practices.
npm install -g generator-node-express-firebase
Make a new directory, and
cd into it:
mkdir my-new-project && cd $_
yo node-express-firebase, optionally passing an app name:
yo node-express-firebase [app-name]
grunt for building,
grunt serve for preview, and
grunt serve:dist for a preview of the built app.
- Generates a new API endpoint.
yo node-express-firebase:endpoint message [?] What will the url of your endpoint be? /api/messages
server/api/message/index.js server/api/message/message.spec.js server/api/message/message.controller.js
grunt test will run the client and server unit tests with karma and mocha.
grunt test:server to only run server tests.
Keeping your app secrets and other sensitive information in source control isn't a good idea. To have grunt launch your app with specific environment variables, add them to the git ignored environment config file:
-── server ├── api - Our apps server api ├── config - Where we do the bulk of our apps configuration │ └── local.env.js - Keep our environment variables out of source control │ └── environment - Configuration specific to the node environment
An example server component in
thing ├── index.js - Routes ├── thing.controller.js - Controller for our `thing` endpoint └── thing.spec.js - Test
When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
When submitting a bugfix, try to write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
When submitting a new feature, add tests that cover the feature.
travis.yml for configuration required to run tests.