AbobkerElaghel / rbk-platform-backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo

RBK E-Learning Platform - Backend

Short description

RBK E-Learning Platform

Based on paper dashboard UI template

This project is made by the outcomes team of RBK Tunisia. It is a Learning Management System designed to meet the needs of RBK's instructional team in terms of material and class coordination.

Table of contents

Quick start

Installation Guidelines

Prerequisites

If you don’t havee any of these tools installed already, you will need to:

 Download and install git
 Download and install nodejs https://nodejs.org

Get Started

You will need to clone source code of client GitHub repository. To do this open console and execute following lines:

git clone https://github.com/rbk-outcomes/rbk-elearning-backend.git

Setting your environment

The file .env is meant to set the environment variables. Request a copy of this file from the team.

Build Setup

install dependencies

 cd rbk-elearning-backend
 npm install

serve localhost:3000

npm start

test

npm run test

Status

RBK E-Learning Platform is in development process

What's included

Here is the folder structure (do not forget to update this)

├───config
|
├───Controllers
|
├───models
|
├───operations
|
├───public
|
├───routes
│   └───api
├───Services
│
├───uploads
|
├───views

Contribution guide

  • Fork the repository
  • npm install or yarn install
  • Make changes
  • Create a new branch with your name and the feature name e.g: branch name : your-name-feature-name
  • Open Pull Request

Link to Documentation

For detailed explanation on how things work, checkout the guide

Please read through our Endpoint guidelines. Included are directions for making an endpoint and notes on development.

Please Read our coding style and contribution guidelines.

Moreover, all Javascript should conform to the Code Guide, maintained by standard.

Live Demo

Check the Live Demo here.

Creators

Heni Mezrani

Zied Barhoumi

Thanks

Thanks to the team

Copyright and license

Enjoy 🤘

About


Languages

Language:JavaScript 100.0%