eminisolomon / elearninglaravel

ILearning

An E-Learning Website with Chatbox
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Built With

• 
• 

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• PHP 7.3 | 8.0
• PostgreSQL
• Composer

Download and install Composer by following the official instructions.

composer install

Installation

1. Clone the repo

   git clone https://github.com/GuysKapen/ELearningLaravel.git

2. Install NPM packages

   npm install

3. Create database in postgresql

   database create elearning;

4. Modify credetials (username, password) in .env file

   DB_USERNAME=username
   DB_PASSWORD=password

5. Cd to project and run migration

   cd /path/to/project
   php artisan migrate

6. Start server and browse in browsers

   php artisan serve

Deployment (On Fly)

1. Create and link a new postgres database

   flyctl postgres create
   flyctl postgres link <database-name>

2. Config env variables with flyctl (database connections, mail connections, etc ...)

   flyctl secrets set ...

3. Connect to the app to run migrate, link storage

   flyctl ssh console
   cd /var/www/html
   php artisan migrate
   php artisan storage:link

Usage

• For Developers:

  • Clone repo and start development as with Laravel
  • Add more author and student features
  • Add API for REST

• For Users:

  • Add courses, quizzes to website and host it online
  • Add more meta data such as categories, tags, ...

Roadmap

• Admin
  • Courses
  • Categories
  • Languages
  • Programming Languages
  • Approve and Notification
• Author
  • Dashboard
  • Courses
  • Tools
  • Resources
  • Profile
• Student
  • Search Course
  • Enroll/Buy Course
  • Do Quiz
  • Course Result
• Course creation
  • Landing
  • Curriculum
  • Assessment
  • Pricing
  • Metadata
• Quiz feature
  • Auto save answer
  • Persistent do quiz session after logout
  • Allow preview answer

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

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

License

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

Contact

Guys - [email protected]

Project Link: https://github.com/GuysKapen/ELearningLaravel

Acknowledgments

• Laravel
• TailwindCSS
• NPM
• Composer