README.md

Kathena Online Learning Management Platform

Kathena online learning manegement platform v1.0.1

NestJS, ReactJS, Typescript, GraphQL, MongoDB, Node Mailer,...

Getting started

Prerequisites

• Node: Install version 12.22.x or greater (Only version 12)
• Yarn: See installation instruction here
• MongoDB: See installation instruction here

Installation

• Clone or fork this repository.

• Rename packages/server/.env.example to packages/server/.env

• Fill in your environment information same to .env.example

  • PORT: Your config port server (default: 4000).
  • MONGODB_URI: Database connection string URI format.
  • INIT_ADMIN_PWD: Default password for initial admin user(Run with devtool).
  • ENABLE_DEVTOOL_MODULE: Boolean ( true/ false) - Enable devtool.
  • FILE_STORAGE_UPLOADS_DIR: Path to directory to storage the uploaded files. Relatives to this directory.
  • FILE_STORAGE_PROVIDER: LocalStorage or AwsS3.
  • PORT_WEB: Your config port web (default: 3000).
  • MAIL_HOST: Your server mail.
  • MAIL_USER: Your mail user.
  • MAIL_PASSWORD: Your mail password.
  • MAIL_FROM: Your mail user.
  • MAIL_DOMAIN: Your web domain.

• Run yarn install to install npm dependencies.

Running locally

Run yarn start:server to run backend and run yarn start:web to run frontend.

Communication Channels

The easiest way to communicate with the team is via GitHub issues. Please file new issues, feature requests and suggestions, but DO search for similar open/closed pre-existing issues before creating a new issue. Join Discord Server: https://discord.gg/nQvAdcGXUA

License

Distributed under the MIT license. See LICENSE for details.