Skip to content

Codecademy-style webapp that lets you create and learn from interactive coding tutorials. Client-side only for simplicity. Note: No longer maintained.

License

Notifications You must be signed in to change notification settings

MissouriMRR/propguard

Folders and files

NameName
Last commit message
Last commit date
Jun 12, 2021
Mar 19, 2020
Mar 16, 2020
Jun 4, 2020
Feb 19, 2020
Mar 19, 2021
Jun 12, 2021
Jun 12, 2021
Feb 5, 2021
Mar 16, 2020
Jun 7, 2021
Mar 16, 2020
Mar 16, 2020
Jun 8, 2021
Apr 4, 2020
Jun 3, 2022

Repository files navigation

Stargazers Issues


Propguard

Propguard is a Codecademy-style webapp that lets you create and learn from interactive coding tutorials. Client-side only, no servers needed except for hosting instances.

Table of Contents

What is this?

Propguard is a web app built for Missouri S&T's Multirotor Robot Design Team meant to preserve the knowledge and experience of its past members. Propguard teaches new members how to start working on the team's flight code via a Codeacademy-like tutorial interface that includes a simple text editor and basic mock-output.

This app also includes a tutorial editor for creating and editing existing tutorials. In order to make this project client-side only, we use GatbyJS which lets us more easily manage tutorials as JSON files. In order to update tutorials on the live instance, we can just edit the JSON files in src/data and update the repo.

Usage

Continue on if you want to run this locally. Otherwise go here for a quick demo.

For more info on how to use Propguard, reference our user guide.

Get started

Requirements

Installation

  1. Clone the repository to a folder of your choosing
git clone https://github.com/MissouriMRR/propguard.git
  1. Install the required packages for the project
yarn install
  1. Run the development version of Propguard
yarn start
  1. Now play around, code, and enjoy!

Contributing to the codebase

  1. Follow the get started section and get your project set up
  2. Create a new branch for your feature (git checkout -b feature/my-feature)
  3. Commit your changes with (git commit -m "Added my feature which does X")
  4. Push the branch to the remote repo (git push origin feature/my-feature)
  5. Open a pull request.
  6. Free feel to contact any member of the Missouri S&T Multirotor Design Team for help!

Deploy

To deploy the live version/demo with the latest changes from the main branch, clone the repo, yarn install, and then yarn deploy.

Roadmap and progress

See the Projects section for more tasks and feature improvements. Otherwise most functionality of Propguard is complete.

Adding/editing tutorials

Visit here for more information about contributing your own Propguard tutorials.

We'll flesh this out more when we finish the editor!

Tutorial Schema

type Tutorial {
  name: String!
  description: String!
  instructions: [Instruction]
}


type Instruction {
  title: String!
  hint: String!
  output: Output!
  content: [InstructionContent]!
  solution: String!
}

type InstructionContent {
  type: String!
  value: String!
}

About

Codecademy-style webapp that lets you create and learn from interactive coding tutorials. Client-side only for simplicity. Note: No longer maintained.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published