yarn
yarn start:<PACKAGE_NAME>
ORyarn start
should you wish to serve both the frontend and backend in parallel
You'll find a React App in packages/client
. You will find it to contain a Lobby and a Classroom:
- Lobby
- Classroom
note: this is not mobile responsive at the moment.
This is the first page a user sees. It contains the following:
- Select dropdown for user to select "student" or "instructor" role
- Input text field for user to enter a room id.
- Button that takes the user to the Classroom as a Student or Instructor depending on the role selected.
- Each classroom hosts a maximum of one student and one instructor at a time.
- Displays error message when:
- The room id + role is already in use.
- The room is full.
STUDENT VIEW:
The Classroom contains a Code Editor. The Code Editor is built using the Ace editor. The specs are as follows:
- The left panel is for code input (built using the Ace editor)
- The right panel is for code output (Using an overridden Console object)
- The Code Editor only needs to handle Javascript input.
- Above the Code Editor are two buttons:
- The first button runs the input code and outputs its results onto the right panel.
- The second button submits the input code to the instructor.
INSTRUCTOR VIEW:
- The Classroom displays the student's submitted code.
- Submitted code updates in real time.
You'll find an Express app in packages/server
. It handles:
- Rooms (stored in memory)
- Code submissions