Generator for scaffolding a feathers app

[ekryski]

Since feathers is very modular it can be tough for a newcomer to get a handle on all the modules required for an app. We want to keep everything modular and flexible but still provide all the functionality you would expect in a real-time framework. We are inspired by, and run on top of Express after all!

So with that we should create a yeoman generator that scaffolds an application.

It should promp you for:

• Project Name
• Description
• License (using Proprietary by default)
• URL (left to the user, we may pre-poulate with your-app.feathersjs.com)
• Author (left to the user)
• Database
• Whether you need websockets and if so which type
• Whether it serves static content (should always as it's baked into Express)

It should then generate the app with the following dependencies if the user answered yes to above questions:

• body-parser
• CORs
• serve-favicon
• compress
• winston
• feathers
• feathers-config
• feathers-logger (deprecated in favour of using your own)
• feathers-hooks
• feathers-authentication
• feathers-sync (not ready, it's more of an advanced guide thing)
• feathers-[database adapter]
• feathers-[transport plugin]

A suggested folder structure would look like:

root
    -> public/
        -> 404.html
        -> 500.html
        -> index.html
    -> client/
        -> js/
        -> css/
    -> server/
        -> config/
            -- development.json
            -- production.json
        -> services/
        -> routes/
            -> api/
            -> public/
        -> lib/
            -> hooks/
            -> middleware/
        -> views/
        -> test/
        -- index.js
    -> README.md
    -> package.json
    -> Dockerfile
    -> .gitignore
    -> .npmiginore
    -> .jshintrc

High Level Tasks Remaining

• Update to feathers-2.0.0
• Update to hooks-1.0.0
• Inject data store setup based on database selected
• Scaffold a user model based on database selected
• Scaffold a user service based on database selected
• Scaffold JWT authentication based on auth method(s) selected
  • Local (username/password) (in progress)
  • Twitter (not going to make it for this release. OAuth1 support won't make this release)
  • Facebook
  • LinkedIn
  • Google
  • Github
  • Bitbucket
• Scaffold a basic logger
• Generate basic error pages
• Generate error handler middleware
• Be able to generate a new service
• Be able to generate a new before hook (using promises)
• Be able to generate a new after hook (using promises)
• Style error and index pages
• Add favicon
• Add code comments

[ekryski]

Work has started on this here: https://github.com/feathersjs/generator-feathers

[daffl]

Since I need this anyway, I started working more on it in https://github.com/feathersjs/generator-feathers/tree/app-architecture. I think https://github.com/feathersjs/generator-feathers/tree/app-architecture/app/templates/src is a good start.

[marshallswain]

Do we want to take cookie-parser off this list, since we'll be using tokens, now?

[ekryski]

Ya I think we can scratch out cookie parser.

[ekryski]

Finally this is done! Closed by feathersjs-ecosystem/generator-feathers#49

[lock]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue with a link to this issue for related bugs.