Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eyuelberga/theclassroom

Learning Management System built with Hasura
https://github.com/eyuelberga/theclassroom

Last synced: 10 days ago
JSON representation

Learning Management System built with Hasura

Host: GitHub
URL: https://github.com/eyuelberga/theclassroom
Owner: eyuelberga
License: mit
Created: 2022-03-21T11:09:38.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-03-03T04:55:10.000Z (almost 2 years ago)
Last Synced: 2023-03-06T01:57:27.940Z (almost 2 years ago)
Language: TypeScript
Size: 2.21 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

The Classroom is a learning management system, similar to Google Classrooms, where
Teachers can share school resources with their Students.

The project was built using React, Auth0, and the Hasura GraphQL Engine.

## Preview
![Landing](assets/theclassroom_landing.png)

![Dashboard](assets/theclassroom_dashboard.png)

![Create Classroom](assets/theclassroom_create_classroom.png)

![Add Assignment](assets/theclassroom_add_assignment.png)

![Schedule Assignment](assets/theclassroom_schedule.png)

## Setting up Hasura

The Hasura project files are located in the folder `hasura`. You can use the Hasura CLI to start a local instance or deploy it remotely.

## Setting up Auth0

For Hasura and Auth0 to work properly, you need to set up two actions, which can be found in the `/auth0/actions` folder.

Both actions have two environment variables you need to supply:

```
HASURA_GRAPHQL_HTTPS_URL: absolute URL to the GraphQL API
HASURA_ADMIN_SECRET: admin secret for the API

```

- `post-login-add-jwt-clams` action should be added to the `Login` flow
- `post-registration-sync-with-hasura-db` action should be added to the `Post User Registration` flow

You also need to get the JWT secret from Auth0. use [this link to get the JWT config](https://hasura.io/jwt-config/).

A custom login page with extra fields for full name and account type is also found in the `auth0/custom-login-page.html`

## Setting the APIs for scheduling and email notification

There are two APIs that need to be deployed. These are:
The scheduler API for creating One-off Scheduled events and another endpoint for publishing a class resource. It is located at `apis/scheduler`
The Email notification API for sending emails to enrolled students when a teacher publishes a new class resource. It is located at `apis/send_email`. You also need a [Mailjet](https://www.mailjet.com/) account for this.

After running the two APIs, you need to link them to Hasura using env vars:
```
SCHEDULE_API_BASE_URL
EMAIL_NOTIFICATION_WEB_HOOK_URL
```

## Setting up the React frontend

The front-end is located at `/web`. You just need to add the following env vars:

```
REACT_APP_GRAPHQL_HTTPS_URL
REACT_APP_GRAPHQL_WSS_URL
REACT_APP_AUTH0_DOMAIN
REACT_APP_AUTH0_CLIENT_ID
REACT_APP_AUTH0_AUDIENCE
```

## License