Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BarkleyREI/generator-brei-app
Yeoman Generator for projects
https://github.com/BarkleyREI/generator-brei-app
Last synced: 3 days ago
JSON representation
Yeoman Generator for projects
- Host: GitHub
- URL: https://github.com/BarkleyREI/generator-brei-app
- Owner: BarkleyREI
- Created: 2013-08-17T19:34:06.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-26T19:34:01.000Z (9 months ago)
- Last Synced: 2024-10-02T08:24:56.358Z (about 1 month ago)
- Language: JavaScript
- Size: 872 KB
- Stars: 2
- Watchers: 8
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
Awesome Lists containing this project
README
# generator-brei-app
[![Version npm][version]](http://browsenpm.org/package/generator-brei-app)
[](https://travis-ci.org/BarkleyREI/generator-brei-app)
[version]: http://img.shields.io/npm/v/generator-brei-app.svg?style=flat-square
## Getting Started with a Project
Install Yeoman
```bash
npm install -g yo
```
Install the BREI App Generator
```bash
npm install -g generator-brei-app
```
Finally, initiate the generator in an empty directory:
```bash
yo brei-app
```
From here you will be presented with a series of options. The options will differ depending on the contents of the directory.
```bash
What would you like to do? (Use arrow keys)
❯ Create a New Modern Project
Create a New Pattern Library (Alpha)
Create a Template
Create an Organism
Create a Molecule
Create an Atom
Create a Partial
Create a Module
```
Just follow the prompts and off you go!
### Dropbox
- Do not stage the project (run npm install or other dependency managers) from Dropbox. The dependency folders, especially `node_modules`, contain thousands of files and directories, and Dropbox can freeze the disk or cause permissions errors while it syncs.
## Sub-Generators
#### All Sub-Generators install the properly formatted .hbs and .scss file according to BarkleyREI front-end coding standard conventions.
#### Note: you can either run `yo brei-app` and select the desired sub generator task, or you can use the following commands to do it manually.
Create a new Modern Project:
```bash
yo brei-app:new
```
Create a new Pattern Library Project:
```bash
yo brei-app:pattern
```
Create a new Template:
```bash
yo brei-app:template
```
Create a new Organism
```bash
yo brei-app:organism
```
Create a new Molecule
```bash
yo brei-app:partial
```
Create a new Atom
```bash
yo brei-app:partial
```
Create a new Partial (LEGACY)
```bash
yo brei-app:partial
```
Create a new Module (LEGACY)
```bash
yo brei-app:module
```
## Testing the Generator
**This only needs run if you are locally modifying the generator files in this repo, not a project created with it.**
To Test:
```bash
npm test
```
The test takes about 3-4 minutes to run.