Prerequisites: This project requires NodeJS
From the repository root, run the following command to install all necessary dependencies:
npm ciTo run this project locally, use the following command in the repository's root directory. This will start a server on http://localhost:8080/. The server has hot-reload enabled so changes to files will be reflected in the browser immediately.
npm run serve-
Copy
_template/inoutcomes/. Use lower case letters and dashes (-) only for the directory name. This will be the slug which will be needed later. -
In your new directory, rename
_template.11tydata.jstonew-dir-name.11ty.data.jswherenew-dir-nameis whatever you called the directory. -
in
outcomes.jsonset thetitleto be the short name of the outcome. Examples:Non-text content,Error notification, etc. Add a 3 - 4 sentence description todescription. Theindexis a number to help sort outcomes in order. Leave at0if you do not know what this should be. -
Fill out the
.mdfiles in your new directory
-
Copy the method template from
outcome/_template/methods/_templateto themethodsdirectory of the outcome you are creating a method for -
Give the copied directory an appropriate name
-
Rename
_template.jsonto match the directory name, and update its content. Give the method atitle(1 - 4 words) and a description (2 - 4 sentences). Theslugmust be the directory name. Useindexto sort methods. -
Fill out the
.mdfiles in your new directory