If you would like to contribute but are having trouble getting started, try reaching out to us over Gitter, or contact me on Twitter @kmcquade3.
We use Node v14.5.0. I suggest using Node version manager for managing multiple Node installations. This is suggested but not required. Instructions can be found here.
- Check the Node version matches v14.5.0
node --version # should return: # v14.5.0
- Install dependencies from the root directory
We've already preconfigured several
npm commands to be run inside the package.json file, so you don't have to remember to use
vue-cli-service serve --mode development, for example - you can just use
- Spin up a local version of the report, using sample data.
You can then access the application over http://localhost:8080.
- Run unit tests
- Add a new
- Add your function in this code. See other files in that folder for an example.
Ensure that there is an
exports myfunction = myfunction;line at the end of the file
Add a new
.jsfile under /cloudsplaining/output/src/test.
- Use this to store your unit tests. See other files in that directory for examples.
Adding new Vue Component: Checklist
- Add a new file under /cloudsplaining/output/src/components.
- Ensure that the component is imported in the App.vue file.
- Ensure that the component is added as a component in the component listing in the App.vue file.
- Ensure that the component is leveraged in the HTML
templatewithin that App.vue file.
- Ensure that unit tests run successfully
Building the report for testing
Step 1: Make sure it builds successfully locally first with
npm serve # You can then access the application over http://localhost:8080
npm build command will also generate a file titled
index.bundle.js file (the application code) and the
chunk-vendors.js file (the dependencies) into a nearly identical file - template.html - along with the results of the Cloudsplaining scan. The relevant sections of the template.html file look like this:
Step 3: Create the new sample report
This will generate a new report at