Educational resources for the St. Jude Cloud project.
Explore the docs Β»
Request Feature
|
Report Bug
β Consider starring the repo! β
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 of the St. Jude Cloud University codebase is relatively simple. Follow these guidelines to keep you between the rails π:
-
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.
-
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 ofgit 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).
-
The following integrations have been enabled or are in development. As such, you don't need to do anything other than commit!
- Automated building with GatsbyJS π§°.
- Automated versioning with conventional commits,
conventional-changelog
, and semantic-release π. - Automated production release and branch previews with Netlify π.
- Automated search engine indexing with Algolia π.
- Automated integration with Intercom for support questions in browser π¬.
- Automated spell checking π.
- Automated link validation π.
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 Β© 2021 St. Jude Children's Research Hospital.