/handbook

A guide for members of the Suncoast Developers Guild

Primary LanguageHTMLCreative Commons Attribution Share Alike 4.0 InternationalCC-BY-SA-4.0

Suncoast Developers Guild Handbook

License: CC BY-SA 4.0

A guide for students of the Suncoast Developers Guild.

🚀 Quick start for contributors

  1. Enter the web directory.

    cd web

  2. Install dependencies.

    We use the yarn package manager.

    yarn install

  3. Start developing.

    Navigate into the site’s directory and start it up.

    cd web
yarn start

  4. Open the source code and start editing!

    The handbook is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying data. Learn more about using this tool in the Gatsby tutorial.

🧐 What's inside?

A quick look at the some of the files and directories you'll see.

.
├── assignments
├── lessons
├── meta
├── programs
├── warm-ups
├── web
├── .prettierrc.json
├── LICENSE
├── README.md

  1. /assignments: This directory contains markdown formatted Assignments referenced by Lessons.

  2. /lessons: This directory contains Lesson definitions. Each lessons contains markdown-formatted reading, lecture notes and associated presentations.

  3. /meta: Legacy content and some other things like writing style guides, work-in-progress lessons, etc.

  4. /programs: YAML definitions of the Programs offered by SDG. This is where a Program is associated with Lessons (via Modules).

  5. /warm-ups: A sort-of miniature lesson/assignment used as a warm-up or practice outside of lecture time.

  6. /web: This directory contains the actual Gatsby project the powers our Handbook.

  7. .prettierrc.json: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of code consistent. All contributions to this repository should be formatted according to these rules.

  8. LICENSE: Our Handbook's content is licened up a Creative Commons (CC BY-SA 4.0) license. The web application is MIT.

  9. README.md: You're looking at it!

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website.