Marco-Peter / TaikoBot

Webapplication to manage taiko lessons and more

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Taikobot

Taikobot targets to help organizing Taiko courses and workshop as well as getting news and information out to the members.

Since it still is in a very early development stage, a lot can (and probably will) change over the time.

Currently features at work are:

  • Create edit and manage Courses with the lessons as well as workshops
  • Let all members see their currently signed in courses as well as their upcoming lessons. Also give them a way to manage their participation in the lessons.
  • Let members sign into new workshops and courses online.
  • Give teachers a simple tool to plan out lessons by using the lesson notes.

Intended features and ideas for the future

  • Send notifications to the users about upcoming lessons and important messages.
  • have a simple message board between teachers and the students of a course.
  • Have supporting material like note sheets and documents for the participants of a course.

Installation and development

Taikobot builds on top of the Laravel framework (see below) and their Jetstream starter kit

For develpment purposes it can be used in a PHP8.1 or newer environment, which can be run natively on the computer or in a Docker container using Laravel Sail.

Setup of Sail-Environment (Docker)

  1. Clone repository into a directory under the WSL or Linux environment.
  2. Execute the sail_setup.sh script.
  3. Start sail (.vendor/bin/sail up -d, or sail up -d, when shell alias is set).
  4. Install JavaScript dependencies (sail npm install).
  5. Migrate database (sail artisan migrate --seed).
  6. Generate application encryption key (sail artisan key:generate).
  7. Build the javascript files (sail npm run build).

Laravel Logo

Build Status Total Downloads Latest Stable Version License

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

You may also try the Laravel Bootcamp, where you will be guided through building a modern Laravel application from scratch.

If you don't feel like reading, Laracasts can help. Laracasts contains over 2000 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel Patreon page.

Premium Partners

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via taylor@laravel.com. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.

About

Webapplication to manage taiko lessons and more

License:MIT License


Languages

Language:PHP 51.1%Language:Vue 47.4%Language:JavaScript 0.9%Language:Blade 0.5%Language:Shell 0.1%Language:CSS 0.0%