/university

Educational materials for the St. Jude Cloud project.

Primary LanguageJavaScript

St. Jude Cloud University

Status Github Issues GitHub pull requests License: MIT Slack Channel

Educational resources for the St. Jude Cloud project.
Explore the docs ยป

Request Feature | Report Bug
โญ Consider starring the repo! โญ


Quick Start

You can use the following commands to get started working with St. Jude Cloud University.

# install all of the dependencies
npm install

# run a development mode server
npm run develop

# create a production build in the `public/` folder
npm run build

Development

Development of the St. Jude Cloud University codebase is relatively simple. Follow these guidelines to keep you between the rails ๐Ÿ‘:

  1. Use the commands in the quick start section to set up the code base, install dependencies, run a development server, and execute your own production build.

  2. This project enforces conventional commits using the conventional-changelog verbs. A large chunk of automation is built off of this convention, so please follow it!

    • Reading the above material is suggested, but not required for development.
    • If, in practice, you use git cz (which calls [commitizen] underneath the hood) instead of git commit, then this will be taken care of. This is the suggested method for beginners.
    • If you're updating content (e.g. the documentation) and not source code, be sure to use the appropriate verb (e.g. use docs: for documentation upgrades).
  3. The following integrations have been enabled or are in development. As such, you don't need to do anything other than commit!

Contact

With any issues you encounter with the repo, please file an issue report. For any other questions, please contact us at support@stjude.cloud.

COPYRIGHT

Copyright ยฉ 2021 St. Jude Children's Research Hospital.