Skip to content

Latest commit

 

History

History
138 lines (82 loc) · 6.63 KB

README.md

File metadata and controls

138 lines (82 loc) · 6.63 KB
Raw

OnLearn (POC) 🚀🚀🚀

tests codecov CodeFactor Renovate Quality Gate Status Reliability Rating Maintainability Rating Security Rating Vulnerabilities Technical Debt Bugs time tracker

A simple online Learning Management System (LMS) built with Node.js.

This project isn't production-ready. At best it is a Proof Of Concept (POC).

🚨 Important links to check out

  1. You can find the project's kanban board 👉 here 👈

  2. You can find the project's mockup 👉 here 👈

  3. You can find the project's database diagram 👉 here 👈

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them.

NPM / Yarn
Code Editor (This app was built on VSCode)
Git
Cloudinary Account
OAuth 2.0 Clients (Google API)

Cloudinary

Cloudinary is an end-to-end image- and video-management solution for websites and mobile apps, covering everything from image and video uploads, storage, manipulations, optimizations to delivery.

All images and/or videos uploaded within this app are stored in a cloudinary account. You will need to create your account if you want to properly test this functionality out locally.

Setup:

  1. Create an account at Cloudinary.

  2. Navigate to your Cloudinary dashboard to find the variables you will later need to add to the .env file (See How To Use section below)

Google API (OAuth 2.0)

Google APIs are application programming interfaces developed by Google which allow communication with Google Services and their integration to other services.

The authentication process of this application utilizes Passport's Local and Google Strategy.

In order for Google to identify which application's Passport interacts with their API, you will need to obtain clientID and clientSecret in Google Developers Console. You may refer to this guide for the steps.

Installing

To get this project on your local machine, you first need to clone it using the git clone command.

git clone https://github.com/reMRKableDev/OnLearn

Running this on your terminal will ensure you receive the latest version with all it's changes.

Once you've cloned it, install all dependencies using:

npm install

This should retrieve all the necessary dependencies named in the package.json file.

How To Use:

Once dependencies are installed, be sure to include a .env file with the necessary environment variable:

LOCAL_MONGO_URI = <mongodb uri goes here...>
SESSION_SECRET = <session secret goes here...>
PORT = <port number goes here...>

DUMMY_PASSWORD = <custom dummy pwd goes here...>
DUMMY_EDIT_PASSWORD_WEAK = <custom weak dummy pwd goes here...>
DUMMY_EDIT_PASSWORD_STRONG = <custom strong dummy pwd goes here...>

GOOGLE_CLIENT_ID = <your google client id goes here...>
GOOGLE_CLIENT_SECRET = <your google client secret goes here...>

CLOUDINARY_NAME = <your cloudinary name goes here...>
CLOUDINARY_KEY = <your cloudinary key goes here...>
CLOUDINARY_SECRET = <your cloudinary secret goes here...>

When everything is in place, the application can be run locally using:

npm run dev

Running tests 🧪

The testing framework utilized is Jest. Tests can be run by using the command:

npm test

OR

npm run test

To run tests and see the code coverage. RUn using the command:

npm run coverage

Contributing 👋

If you would like to contribute to this repository, follow the guidelines provided in the CONTRIBUTING.md file.

Code Of Conduct 📋

Please note that there is a CODE_OF_CONDUCT.md, please follow it in all your interactions with the project.

Authors 💻

Acknowledgments 🗣️

The initial inspirations for this project are:

License: MIT