README.md

French Press

---

An opinionated ReactJs + Webpack generator for CoffeeScript.

---

What's in the box?

• Generators:

  • Base app
    • Builds router
    • Adds mixin folder
    • Adds webpack config
    • Generates a test suite
    • Replaces refs to french-press with your own
    • if redux
      • Builds using a different base
      • Adds container component
      • Requires intervention to produce a functional app
  • View component (base component)
    • All come with tests
    • Full
      • Comes with routes
    • Slim
      • Comes with routes
  • Child component
    • All come with tests
    • Full
      • No route included
    • Slim
      • No route included
  • Navigation
    • Comes with tests
    • No route included
  • Reducers
    • With middleware
    • Without middleware
  • Middleware

• Actions:

  • Reset
  • Run
  • Compile for production
  • Test
  • Generator tests
  • ⚠️ Remove Generators ⚠️

• Included modules other than React:

  • Bemmer - Create BEM with ease
  • lodash - The missing standard lib
  • moment - Parse, validate, manipulate and display dates
  • React Mini Router - Easy routing
  • Redux - Functional flux store for your data

---

Install Requirements

  npm install

---

Usage

Total reset

‼️ This will remove all generated content in your project use with extreme caution ‼️

  ./fp clean

---

Run as local server

  ./fp run

---

Compile for production

  ./fp build

---

Test

  ./fp test

---

Generator tests

‼️ This will remove all generated content in your project! Use before generating anything ‼️

  ./fp clean && npm run spec && ./fp clean

---

Remove the generators and leave your new application

⚠️ This will remove all generators.

  ./fp implode

---

Generate a new application

You will want to rm -rf .git and git init before running this command

With redux

  ./fp g --app --appName [AwesomeApp] --author [YourName] --ghUser [GitHubUserName] --email [some@one.com] --redux

Without redux

  ./fp g --app --appName [AwesomeApp] --author [YourName] --ghUser [GitHubUserName] --email [some@one.com]

---

Generate a view [full]

NB: Components are placed in components/[componentName]/index.coffee by default

As a normal component with no customizations (route will match method name)

  ./fp g --view --[componentName]

As base route

  ./fp g --view --[componentName] --route root

With custom route

  ./fp g --view --[componentName] --route [customRouteName]

With custom folder name NB: This will cause the component to be named based on the actual name of the function

  ./fp g --view --[componentName] --componentFolder [componentFolderName]

Generate a view [slim]

  ./fp g --view --[componentName] --slim

---

Generate a component [full]

NB: Components are placed in components/[componentFolderName]/[componentName].coffee by default

  ./fp g --component --[componentName] --folder [componentFolderName]

Generate a component [slim]

  ./fp g --component --[componentName] --folder [componentFolderName] --slim

---

Generate navigation

  ./fp g --navigation

Generate reducer with middleware

  ./fp g --reducer --middleware --store [storeName]

Generate reducer without middleware

  ./fp g --reducer --store [storeName]

Generate middleware

• This is just a shell. It will require some work to complete a functional middleware module

  ./fp g --middleware --name [middlewareName] --store [storeName]

---

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/whatisinternet/french-press. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.