andrenoberto/serverless-elearning

API-First Headless virtual learning environment built on top of AWS serverless architecture.

Serverless e-Learning

Description

API-First Headless virtual learning environment built on top of AWS serverless architecture.

Contents

• Development Board
• Supported Providers
• Services Used
• Quick Start
• Contributing
• Licensing

Development Board

• Serverless e-Learning Board on Jira

Supported Providers

• AWS

Services Used

• API Gateway
• Cognito
• CloudFormation
• CloudWatch
• DynamoDB
• Elemental MediaConvert
• IAM
• Lambda
• S3
• SNS

Quick Start

Feel free to use npm or yarn to run all scripts provided in this source code.

1. Install via npm or yarn:

Using npm:

npm install

Using yarn:

yarn

2. Set your environment variables:

Rename the example environment variables file from

.env.example

To

.env

After this, set up the variables inside this file with the appropriated values.

3. Run TSLint:

yarn test

4. Offline development server:

yarn start-offline

5. Deploy your code to AWS:

yarn deploy

Contributing

Contributors are pretty welcome!

Check out our issues or feel free to make PR's and discuss about new features.

Licensing

Serverless e-Learning is licensed under the MIT License.

All files located in the node_modules and external directories are externally maintained libraries used by this software which have their own licenses; we recommend you read them, as their terms may differ from the terms in the MIT License.