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 buildDevelopment 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-changelogverbs. 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.