Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/escolalms/courses
Courses and content package
https://github.com/escolalms/courses
headless laravel lms
Last synced: 4 days ago
JSON representation
Courses and content package
- Host: GitHub
- URL: https://github.com/escolalms/courses
- Owner: EscolaLMS
- License: mit
- Created: 2021-03-09T16:26:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T10:54:19.000Z (about 1 month ago)
- Last Synced: 2024-10-14T07:24:53.845Z (about 1 month ago)
- Topics: headless, laravel, lms
- Language: PHP
- Size: 74 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Courses
Courses and content package
[](https://escolalms.github.io/Courses/)
[](https://codecov.io/gh/EscolaLMS/Courses)
[](https://github.com/EscolaLMS/Courses/actions/workflows/test.yml)
[](https://packagist.org/packages/escolalms/courses)
[](https://packagist.org/packages/escolalms/courses)
[](https://packagist.org/packages/escolalms/courses)
[](https://codeclimate.com/github/EscolaLMS/Courses/maintainability)
[](https://dashboard.stryker-mutator.io/reports/github.com/EscolaLMS/Courses/main)
## What does it do
This package is used for creating Course for EscolaLms.
## Installing
- `composer require escolalms/courses`
- `php artisan migrate`
- `php artisan db:seed --class="EscolaLms\Courses\Database\Seeders\CoursesPermissionSeeder"`
## Schedule
- Schedules are available in ScheduleServiceProvider
- `$schedule->job(CheckForDeadlines::class)->hourly()` - executed every hours
- `$schedule->job(ActivateCourseJob::class)->daily()` - executed every days
## Endpoints
All the endpoints are defined in [](https://escolalms.github.io/Courses/)
## Tests
Run `./vendor/bin/phpunit --filter 'EscolaLms\\Courses\\Tests'` to run tests. See [tests](tests) folder as it's quite good staring point as documentation appendix.
## Events
- `EscolaLms\Courses\Events\CourseAccessFinished` => Event is dispatched when users lost access to course.
- `EscolaLms\Courses\Events\CourseAccessStarted` => Event is dispatched when users received access to course.
- `EscolaLms\Courses\Events\CourseAssigned` => Event is dispatched when admin assigned access user.
- `EscolaLms\Courses\Events\CourseDeadlineSoon` => Event is dispatched when course deadline is coming out.
- `EscolaLms\Courses\Events\CoursedPublished` => Event is dispatched when course is published.
- `EscolaLms\Courses\Events\CourseFinished` => Event is dispatched when course is ended.
- `EscolaLms\Courses\Events\CourseStarted` => Event is dispatched when course is started.
- `EscolaLms\Courses\Events\CourseStatusChanged` => Event is dispatched when course has a status change.
- `EscolaLms\Courses\Events\CourseTutorAssigned` => Event is dispatched when tutor is assigned to course.
- `EscolaLms\Courses\Events\CourseTutorUnassigned` => Event is dispatched when tutor is unassigned to course.
- `EscolaLms\Courses\Events\CourseUnassigned` => Event is dispatched when user is unassigned to course.
- `EscolaLms\Courses\Events\TopicFinished` => Event is dispatched when course topic is finished.
## Permissions
Permissions are defined in [seeder](vendor/escolalms/courses/database/seeders/CoursesPermissionSeeder.php)
## Model relation
The model user must be extended with the class HasCourses :
```
class User extends EscolaLms\Core\Models\User
{
use HasCourses;
```
## Database relation
There is simple relation. [see docs for diagram](doc)
1. `Course` general category of the course
2. `Lesson` grouped by Course
3. `Topic` grouped by Lesson
```
Course 1 -> n Lesson
Lesson 1 -> n Topic
Topic 1 -> 1 TopicContent
```
`TopicContent` is an abstract model, this package contains some sample implementatio eg, `RichText`, `Audio`, `Video`, `H5P` and `Image`
You create any of the Content model by post to the same Topic endponit (create and update), [see docs examples](doc)
**Note** that `/api/topics` is using `form-data` - this is due to PHP nature of posting files
List of possible `TopicContent`s is availabe in the endpoint `/api/topics/types`
## Curriculum/Sylabus/Program
App user access the course by fetching `GET /api/courses/{id}/program` endpoint. This is after user purchase or has other access to the course. this endpoints renders tree of Course, Lessons, Topic with Contents essential to render whole course.
## Adding new `TopicContent` type
In the ServiceProvider register your class like
```php
use Illuminate\Support\ServiceProvider;
use EscolaLms\Courses\Facades\Topic;
class CustomServiceProvider extends ServiceProvider
{
//...
public function register()
{
Topic::registerContentClass(TopicContentCustom::class);
// or
Topic::registerContentClasses([TopicContentCustom::class, TopicAnotherContentCustom::class]);
// also register JSON Resource for a type
Topic::registerResourceClasses(Audio::class, [
'client' => ClientAudioResource::class,
'admin' => AdminAudioResource::class,
'export' => ExportAudioResource::class,
]);
}
}
```
see [EscolaLmsCourseServiceProvider.php](src/EscolaLmsCourseServiceProvider.php) as reference as well as [Models/TopicContent](package2/src/Models/TopicContent)
### Content
Package comes with seeder that create course with lessons and topics
```php
php artisan db:seed --class="\EscolaLms\Courses\Database\Seeders\CoursesSeeder"
```