Auto Learn

Table of Contents

1. About The Project
2. Context
3. Built With
4. Documentation
5. Getting Started
6. Contributors

About The Project

This project is called Auto Learn, the principle is simple: an online platform for learning with courses and testing with quizzes.

There are two categories of users:

• The learner: he can take quizzes to test his knowledge on a particular subject. Courses are suggested to him based on the results he has obtained in the tests.
• The admin: he can manage users, courses and tests on the platform.

Features

• Take knowledge tests and get course suggestions based on your score.
• Find courses and tests through various search filters.
• View video or text courses.
• Track your started and completed courses and tests.
• Light and dark theme.

(back to top)

Context

This project is an academic project made during the third year of a Bachelor of Computer Science.
The development was done in a team of 6 people.

(back to top)

Built With

Entire project was built with vanilla PHP and basic MVC architectural pattern. Database used is MySQL.

(back to top)

Documentation

You can find documentation files such as the requirements analysis, technical details, and UML diagrams in the folder docs/.

(back to top)

Getting Started

To get a local copy up and running follow the steps:

Prerequisites

To setup the project, you will need:

• PHP 7.0.0+
• MySQL 5.7+
• Apache Server

Installation

1. Clone the repo:

   git clone https://github.com/Akwd22/auto-learn.git

2. Set PHP include path to the project src folder in your PHP config file:

   include_path = ".;path/to/the/project/src/folder"

3. Init database schema by loading the file db/init_mysql.sql.
4. (Optional) Populate database with mock data by loading the file db/data_mysql.sql.

You are ready to start your Apache server.

(back to top)

Contributors

This project was made by:

• Eddy D.
• Rémy A.
• Clément G.
• Tom B.
• Lilian M.
• Guillaume S.

(back to top)