Curriculum-plan-tool NPM

Study plan generator

Introduction

This tool allows to generate a plan based on a csv file or a project. To run the app perform npm start with parameters, examples see below.

Plan

The csv file has to consist of two columns:

title - title of a plan item (if a title is a subtask title then the title should look like group task title|task title). If you need to add all plan items you can use special title ALL_ITEMS. In this case all a container items will be included in a plan. If a plan has a tasks group the first task will be added.
container - container title of the plan item. You have to use folder name.

There is an example in root directory plan.csv.

To generate a plan you need to run the tool with the next arguments:

type=plan by default it is plan so you can skip it
filePath=filePath path to a csv file. By default it is plan.csv so if your path is the same you can skip it
renderType=html by default it is html so you can skip it. For now the tool support only html type.

A task can have "Depends on" part with list of task which results can be used in the current task. The list must be a list of relative links to tasks of the current container. So a list item will be like * [A task title](../task-folder/readme.md). Group tasks haven't been supported yet. Depended tasks will be rendered at the end of output index file.

Project

To generate a project you need to run the tool with the next arguments:

type=project
projectTitle=projectTitle you have to use folder name as a name. For example beer-catalog
renderType=html by default it is html so you can skip it. For now the tool support only html type.

filePath isn't used for the project command.

Validation

To validate containers you need to run the tool with the next arguments:

type=validation
containers=container-name you have to use folder name as a name. For example nodejs-testing

Technical

Install nodejs. Current node and npm versions can be found in package.json in engines section.

Run npm install --production in the app directory.

You have to use two different commands to generate a plan or a project.

Run:

plan - npm start [type=plan] [filePath=plan.csv] [renderType=html] in the app directory.
project - npm start type=project projectTitle=projectTitle [renderType=html] in the app directory.

If everything is ok outcome folder will be created. The same outcome folder will be used for a plan and a project.