Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goods-services/goodz
🚀 A command-line utility for generating goodness for your react and gatsby apps
https://github.com/goods-services/goodz
cli cli-app gatsby gatsbyjs generator react
Last synced: about 1 month ago
JSON representation
🚀 A command-line utility for generating goodness for your react and gatsby apps
- Host: GitHub
- URL: https://github.com/goods-services/goodz
- Owner: goods-services
- License: mit
- Created: 2019-04-04T16:51:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T04:51:22.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T15:33:53.298Z (about 1 month ago)
- Topics: cli, cli-app, gatsby, gatsbyjs, generator, react
- Language: JavaScript
- Homepage:
- Size: 745 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goodz
> A command-line utility for generating goodness
Goodz allows for structured, repeatable code generation for development teams.
## Install
#### Install globally
```
$ npm install -g goodz
```
#### Install locally in your project
```
$ yarn add goodz --dev
```
```json
// package.json
"Scripts": {
"goodz": "goodz"
}
```
## Usage
```
$ goodz --help
Usage
$ goodz Select from a list of generators
$ goodz Run a generator of that name
Options
-h, --help Display the help screen
-d, --dir Specify base path directory
-v, --version Display the version number
Examples
$ goodz react.component
$ goodz react.component --dir app
```
Uses [Plop](https://github.com/amwmedia/plop) and [Inquirer](https://github.com/SBoudrias/Inquirer.js) underneath... :raised_hands:
## Generators
- [React App](#react-app)
- [React Component](#react-component)
- [React Saga](#react-saga)
- [Gatsby Site](#gatsby-site)
- [Gatsby Template](#gatsby-template)
Generates a functional React app. Based on [Create React App](https://github.com/facebook/create-react-app), but with some added goodness.
```
$ goodz react.app
```
#### Options
```
What is the name of your project?
Should this react app have Redux? (Y/n)
```
Generates a react component inside your app, based on atomic design principles
```
$ goodz react.component
```
#### Options
```
Name of component?" (e.g. Button)
Where should this component live?
choices: ["atoms", "molecules", "organisms", "templates"]
Do you need Styled Components, Material Design, or SCSS?",
choices: ["Styled Components", "Material Design", "SCSS"]
Do you need a Stateless or Stateful component?
choices: ["Stateless", "Stateful"]
Should this component be connected to the redux store? (y/N)
What functions would you like to include?
choices: ["constructor", "componentDidMount", "componentWillMount"]
*statefull components only*
What redux functions would you like to include?
choices: ["componentWillReceiveProps", "mapStateToProps", "mapDispatchToProps"]
*connected components only*
```
#### Output
```
└── src
└── components
└── atoms
└── Button
|── Button.js - Component file
|── Button.style.js - Scoped styled component
|── index.js - For easy reference
└── __tests__
└── Button.test.js - Jest unit test file
```
Generates a saga inside your Redux app
```
$ goodz react.saga
```
#### Options
```
Saga Name? (e.g. counter)
Action Constant? (e.g. COUNTER_INCREMENT)
Reducer Constant? (e.g. COUNTER_CHANGED)
```
#### Output
```
└── src
└── state
|── middleware.js
|── saga.js
└── store.js
└── counter
|── counter.actions.js
|── counter.reducer.js
|── counter.saga.js
└── index.js
```
Generates a Gatsby site readt to go. Site is based on [Gatsby Starter Default](https://github.com/gatsbyjs/gatsby-starter-default)
```
$ goodz gatsby.app
```
#### Options
```
What is the name of your project?
Do you want to use Contentful as a source? (Y/n)
What is your Contentful API Token?
What is your Contentful Space ID?
```
#### Output
```
└── src
└── config
└── gatsby
└── src
```
Generates a Gatsby templates in the templates folder of your Gatsby project.
```
$ goodz gatsby.template
```
#### Options
```
Template Name (e.g. blogPost)
```
## FAQ
#### Why did you make this?
Everyone deserves some goodness from time to time.
## Related
- [Create React App](https://github.com/facebook/create-react-app) - Set up a modern web app by running one command.
- [Redux](https://github.com/reduxjs/redux) - A predictable state container for JavaScript apps.
- [Redux Saga](https://github.com/redux-saga/redux-saga/) - An alternative side effect model for Redux apps.
- [Styled Components](https://github.com/styled-components) - Visual primitives for the component age.
- [Jest](https://github.com/facebook/jest) - Delightful JavaScript Testing.
- [Enzyme](https://github.com/airbnb/enzyme) - JavaScript Testing utilities for React.
- [Gatsby Default Starter](https://github.com/gatsbyjs/gatsby-starter-default) -- Official starter for Gatsby
## License
MIT