Krenovator LMS (backend) is a collaborative learning platform.

• System requirements
• Installation
• Configuration File
  • Database
  • Storage
  • SMTP - Simple Mail Transfer Protocol
• Database Migration
• System Architecture
• Troubleshooting

• NodeJS v12 or higher
• MySQL
• Code IDE - preferably Visual Studio, Vim
• IBM Loopbackframework - Version Loopback 4
• AWS Cloud S3
• SMTP Access

1. git clone
2. npm ci

Back to top

1. Create a file name .env file in root folder
2. Copy the syntax from .env-example to .env and enter the information as below:

Database: MySQL

The model is built with SQL-query in mind. To change it, u need to update the datasource.

Back to top

Database migration is a process to migrate models to database tables or collections. When a migration is finished, the dataset in the source databases resides in target databases.

Auto-migration helps the user create relational database schemas based on definitions of their models together with their relation.

Reference https://loopback.io/doc/en/lb4/Database-migrations.html

Create a new migration

1. Create models
2. Create repository
3. Add model in migrate.ts

Run migration

npm run build
npm run migrate

Back to top

To reduce system complexity, the framework use cloud-based storage.

Reference Loopback-storage-components

1. Go to file.datasource.ts, and change code for const config to below

const config = {
  name: 'File',
  connector: 'loopback-component-storage',
  provider: 'aws',
  key: <AWS_KEY>,
  keyId: <AWS_KEY_PROVIDER>,
  nameConflict: 'makeUnique',
  makeUnique: true,
};

To get AWS_KEY you'll will need to register and go to AWS Console

To change to to local storage follow step belows:

1. In root, create a new folder named storage
2. Change directory inside ./storage and create another folder name similar as STORAGE CONTAINER
3. Go to file.datasource.ts, and change code for const config to below

const config = {
  name: 'File',
  connector: 'loopback-component-storage',
  provider: 'filesystem',
  root: './storage',
};

4. Run application

Back to top