In the project directory, you can run:
Provided you have NodeJS installed, it will download and install every necessary package the app uses.
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
It's universal for every subpage. "Home" button leads to /. If you're logged in, clicking on your username will lead to teacher main page and "Logout" will log you out. Otherwise, "Login" button will lead to login subpage.
In order to join the session, you need to provide your GitHub uername. It will be needed to create branches and generate certain commands to execute later.
Type code of the session you want to join, and join session when you're ready
This is readme of the topic repository. It should contain info helpful or relevant to the topic.
Clicking on "Tutorial" button will teach you how to use checkpoints system. The "checkpoint zero" contains commands necessary to set up a workflow.
When you completed a task stated in checkpoint description, you can commit your changes. The easiest way to do it is to click "Copy" and paste commands to the terminal in topic directory on your machine. Once you do that, check the box next to checkpoint name, so that the teacher knows it's done. Repeat for every checkpoint
Type your GitHub username you registered under
Provide password for your account. Logging in will transfer you to teacher page.
Provide your name and surname
Provide your Github nickname, without "github.com/" prefix
The app requires user token in order to create repositories and branches. Instructions on how to obtain one are displayed when you click on "i" tooltip below
Enter a secure password for your account.
If data provided is invalid, warnings will appear on what is incorrect. Otherwise, your account will be created and you will be redirected to teacher page.
This is a subpage for teachers. From here you can go to subjects list, add a new subject, or manage sessions.
Topic title, also visible to students
Repository dedicated to the topic will have this name. If it does not exist, it will be created
Subject, to which the topic belongs
Determines how many checkpoints will the topic have. A checkpoint is meant to be a milestone or a small task; it is preferred if checkpoints can be rated separately
For every checkpoint, you can define a title and a description. Title should be brief, description should inform students what needs to be done
After successfully adding a topic, a short guide will appear with instructions on how to upload files to repository, including README
Topic name, subjects it belongs to, and hyperlink to repository on GitHub
You can give session a dedicated name, a current date for instance. Creating a session automatically opens it.
Session name and state (active/inactive)
Code necessary to join a session. Click on it in order to make it larger
Closing session prevents anyone from joining it. You can always reopen it later
"Session details" will redirect you to session dashboard
This is a table with students' progress. First column contains usernames, others represent checkpoints. When student completes a checkpoint, a hyperlink to commit will be put in appropriate field