@pareto-engineering/generator-front
v1.1.1-alpha.2
Published
Yeoman is a client-side scaffolding tool for web applications. We use this to quickly scaffold a component, module, page and story.
Downloads
7
Keywords
Readme
Generator-front (Yeoman
)
Yeoman is a client-side scaffolding tool for web applications. We use this to quickly scaffold a component, module, page and story.
Project Installation and Setup
# If you have configured the SSH protocol, use
$ git clone [email protected]:HelloPareto/generator-front.git
cd generator-front
npm install
Usage
Install the
@pareto-engineering/generator-front
package globally$ npm i -g yo @pareto-engineering/generator-front # you might need an older version of yo
Navigate to the folder you want to scaffold either a component, story, module, or page
// For a component $ yo @pareto-engineering/front component [name] # this creates a folder with [name] as it's name with three files in it --> [name].jsx, index.js, styles.scss // For a story $ yo @pareto-engineering/front story [name] # this creates a [name].stories.jsx file --> A story captures the rendered state of a UI component and describes all the states a component can support // For a page $ yo @pareto-engineering/front page [name] # this creates a [name].jsx file // For a module $ yo @pareto-engineering/front module [name] # this creates a folder with [name] as it's name. The folder has urls.js and routes.js files, component and pages folders both having an index.js file