Skip to content

Latest commit

 

History

History
189 lines (123 loc) · 4.74 KB

README.md

File metadata and controls

189 lines (123 loc) · 4.74 KB

Python 3.6 Contributors Issues MIT License LinkedIn


Logo

Learning-Management-System

Boilerplate LMS application built using django-rest-frmaework!


Request Demo · Report Bug · Request Feature

Table of Contents

About The Project

Product Name Screen Shot

This application is a sample of in-house built product Learning Management System with modern cutting edge technologies to ease the learning process. Implemented core backend engine and supporting apps for handling accounts, courses, assignments, discussions and quizzes.

Key Learning:

  • Setting up boilerplates for django project
  • RESTful API development
  • Handling large code base 😄

Of course, no one template will serve everyone since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

Contributors are always welcomed!


Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

To run this project, you should have following dependencies ready:

  1. Python3
  2. pip
  3. MySQL Database

Installation

  1. Clone the repo
git clone https://github.com/umairqadir97/learning-management-system.git
  1. Open terminal in project folder
cd learning-management-system
  1. Install python packages
pip3 install -r requirements.txt
  1. Create 'prepboard_staging' database in MySQL
CREATE DATABASE prepboard_staging;
  1. Enter your database login credentials in engine/settings.py
'NAME': 'prepboard_staging',
'USER': 'user_name',
'PASSWORD': 'password',
  1. Run server
python3 manage.py runserver

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b amazing_features)
  3. Commit your Changes (git commit -m 'Add some Amazing Features')
  4. Push to the Branch (git push origin amazing_features)
  5. Open a Pull Request

Contribution guidelines

  1. Writing tests
  2. Code review
  3. Feature Enhancement

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Muhammad Umair Qadir - Email

LinkedIn: LinkedIn