https://github.com/brikcss/generators
Generators for various projects and repetitive tasks.
https://github.com/brikcss/generators
Last synced: 8 months ago
JSON representation
Generators for various projects and repetitive tasks.
- Host: GitHub
- URL: https://github.com/brikcss/generators
- Owner: brikcss
- Created: 2020-09-05T22:33:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-17T13:31:30.000Z (almost 6 years ago)
- Last Synced: 2025-02-14T17:16:16.875Z (over 1 year ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Generators
Quickly generate boilerplate files or code for various projects and tasks.
## Usage
1. Make sure [hygen](https://www.hygen.io/docs/quick-start) is installed.
2. Copy the generators into your project. You will need to copy the `_templates` folder and the `.hygen.js` configuration file in this repo. There are many ways you can do this, here are a couple:
- Clone as a new git project:
```bash
git clone https://github.com/brikcss/generators && rm -rf /.git
```
- Copy into an existing project:
```bash
# OPTIONAL: Remove existing generators if you want to start fresh:
rm -rf _templates .hygen.js
# Copy generators:
git clone https://github.com/brikcss/generators .__generators && cp -R .__generators/{_templates,.hygen.js} . && rm -rf .__generators
```
- Manually [download this repo](https://github.com/brikcss/generators/archive/master.zip) and copy generators (`_templates`) and configuration (`.hygen.js`) into your project.
3. (optional) Update your root `package.json` with your project details to inform generators. You may also want to remove `README.md`. _Note: You may skip this step, in which case you will be prompted for additional information._
4. Run a generator:
```bash
hygen
```
## Available generators
See [hygen](https://www.hygen.io/) for full details on using generators.
### `project`
- `hygen project new`: Generate a new project. The generator will look first in `package.json`, and prompt you for any other needed information.