README.md

EduCouch - A Cloud Based Learning Management System

EduCouch is a management system intended for educational institution for managing their educational content.
Serverless Application using AWS Amplify, React.js, GraphQL and Datastore.

Table of Contents

• About this project
• One-Click Deployment with amplify console
• Local Deployment
  • Prerequisites
  • Install and configure the Amplify CLI
  • Installation
• Resources

About this project

EduCouch is a monolith application which is built on AWS Amplify Framework and ReactJS.
In the LMS, there will be three actors -

1. Admin
2. Instructor
3. Learner

• From the perspective of an instructor, this LMS tool will be used to manage and support a group of learners.
  Instructors can design the materials for the course.

• From the perspective of a learner, this LMS tool provides access to the course materials provided by the instructor. This could be in the form of a study plan or a lecture schedule with links to materials in the syllabus.

• From the perspective of the admin, this LMS tool allows the educational institution to manage users and content.

Architecture Diagram

AWS Amplify Services used

Frontend

Backend

Other Tools

One-Click Deploy with the Amplify Console

Click the button to deploy this application to the Amplify console.

Local Deployment

Prerequisites

Make sure you have the following installed:

• Node.js v12.x or later

• npm v5.x or later

• git v2.14.1 or later

Install and configure the Amplify CLI

To install and configure

npm install -g @aws-amplify/cli

amplify configure

For complete instructions on how to install and configure Amplify CLI, refer official documentation

Installation

1. Clone the repo, install dependencies

   https://github.com/palakgupta2712/lms-app-amplify.git
   cd lms-app-amplify
   

   Install the dependencies using npm: npm install

   or using yarn: yarn install

2. Initialize the amplify project

   amplify init
   

3. Deploy the services on the cloud

   amplify push
   

   Once all the resources are deployed to the cloud, the src/aws-exports.js file gets created.
   To view deployed services, go to amplify console by running the following command:- amplify console

4. Run the app

   npm start
   

   Open http://localhost:3000 to view it in the browser.

Resources

• Amplify documentation: https://docs.amplify.aws
• Amplify CLI documentation: https://docs.amplify.aws/cli
• Amplify DataStore: https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js
• Amplify Authentication: https://docs.amplify.aws/lib/auth/emailpassword/q/platform/js
• Custom Authentication Flow: https://docs.amplify.aws/guides/authentication/custom-auth-flow/q/platform/js

Additional Libraries

• material-ui
• aws-amplify
• react-router-dom
• boring-avatars
• draft-js
• react-draft-wysiwyg
• react-pdf
• react-player
• dx-react-scheduler

Illustrations

• unDraw
• storyset