@developers-institute/generator-di-project

Project / Exercise Yeoman Generator

Automate generation of Developer Institute projects and exercises.

NOTE! This is currently a proof of concept, but use it and test it, and update it.

Demo

Using the generator

To run this generator:

1. Create a new folder for your exercise or project

2. In your terminal, navigate inside the folder

3. Type the following in your terminal:

   npm init yo @developers-institute/di-project
   

4. Follow the prompts to create your project

5. Gotcha: do not use hyphens in the project/esercise title.

Specifying learning outcomes

The generator accepts a list of learning outcomes as a string, seperated by a comma.

For projects that have learning outcomes worth more than one credit, you need to repeat that learning outcome in the list that amount times.

For example, if my project has learning outcome 1, that is worth two credits, I would specify it like this: 1,1

Running for local development

Configure Yeoman and the generator

1. Install yeoman: npm install -g yo
2. git clone this repository
3. Open this repository in your command line
4. Type: npm link

You now have the generator installed.

Run the generator locally

1. Create and clone an empty GitHub respository
2. Open the repo in your command line
3. Type yo @developers-institute/di-project, and follow the prompts

Releasing a new version

There is no automated process for releasing. A manual release to npm is required.

Recommended: Use np to release a new version.

Support

Not working? Hit up Lance!