Development scripts

We use the following scripts for development. They are specified in package.json

meteor npm run start

meteor npm run start is the standard command to invoke RadGrad in development mode. This configures the system using settings.development.json.

meteor npm run start-custom

meteor npm run start-custom is the same as the above, but allows you to use a customized configuration file that is ignored in commits to the repository. In order to to make use of this command, there is some set-up required:

If radgrad/custom/ does not exist, create it
Copy settings.development.json into it

You can now edit custom/settings.development.json and the meteor npm run start-custom command will use that configuration.

Please be aware that if you want to use custom Assets in your configuration (e.g. a custom databaseRestoreFileName), you will need to place the custom file into app/private/ due to the way Meteor loads assets. If you wish to exclude the custom asset from commits to the repository, place it into a custom/ directory anywhere in app/private/. For more information on the custom/ convention, see here.

meteor npm run lint

meteor npm run lint runs ESLint from the command line. We configure ESLint in .eslintrc.

This command is also specified as the "pretest" script, which means it will be run implicitly when you invoke the "test" script for unit testing.

Any ESLint errors fails the build in continuous integration.

meteor npm run test

meteor npm run test runs the "unit tests", which are server-side tests intended to ensure that the RadGrad data model is implemented correctly.

See the Testing chapter for more detail.

meteor npm run test-app

meteor npm run test-app runs the "integration tests", which are client-initiated tests intended to ensure that client-server communication is implemented correctly.

See the Testing chapter for more detail.

meteor npm run jsdoc

meteor npm run jsdoc generates code-level documentation by running JSDoc over the source files.

See the JSDoc chapter for more detail.

meteor npm run deploy

meteor npm run deploy deploys the system to Galaxy.

See the Deployment chapter for more detail.