Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/escolalms/topic-type-project

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/escolalms/topic-type-project
Owner: EscolaLMS
License: mit
Created: 2023-03-03T14:26:36.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-16T11:52:54.000Z (9 months ago)
Last Synced: 2024-09-19T01:09:39.880Z (about 2 months ago)
Language: PHP
Size: 486 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Topic Type Project

[![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Topic-Type-Project/)

[![codecov](https://codecov.io/gh/EscolaLMS/Topic-Type-Project/branch/main/graph/badge.svg?token=NRAN4R8AGZ)](https://codecov.io/gh/EscolaLMS/Topic-Type-Project)

[![phpunit](https://github.com/EscolaLMS/Topic-Type-Project/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/Topic-Type-Project/actions/workflows/test.yml)

[![downloads](https://img.shields.io/packagist/dt/escolalms/topic-type-project)](https://packagist.org/packages/escolalms/topic-type-project)

[![downloads](https://img.shields.io/packagist/v/escolalms/topic-type-project)](https://packagist.org/packages/escolalms/topic-type-project)

[![downloads](https://img.shields.io/packagist/l/escolalms/topic-type-project)](https://packagist.org/packages/escolalms/topic-type-project)

[![Maintainability](https://api.codeclimate.com/v1/badges/0c9e2593fb30e2048f95/maintainability)](https://codeclimate.com/github/EscolaLMS/Topic-Type-Project/maintainability)

## What does it do

This package is another [TopicType](https://github.com/EscolaLMS/topic-types). It allows students to upload their solutions as files.

This type is used for building headless Course.

The package by default grants students permissions to add and view their own solutions within the course.

Administrators have permissions to display the list of all student solutions, as well as to download and delete them.

## Installing

- `composer require escolalms/topic-type-project`

- `php artisan migrate`

- `php artisan db:seed --class="EscolaLms\TopicTypeProject\Database\Seeders\TopicTypeProjectPermissionSeeder"`

## Endpoints

The endpoints are defined in [![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Topic-Type-Project/)

## Tests

Run `./vendor/bin/phpunit` to run tests.

Test details [![codecov](https://codecov.io/gh/EscolaLMS/Topic-Type-Project/branch/main/graph/badge.svg?token=NRAN4R8AGZ)](https://codecov.io/gh/EscolaLMS/Topic-Type-Project)

## Events

- `ProjectSolutionCreatedEvent` - This event is dispatched when the user has uploaded a solution

You can use the [escolalms/templates-email](https://github.com/EscolaLMS/Templates-Email/tree/main/src/TopicTypeProject) package, which listens to this event and sends an email.

## Listeners

This package does not listen for any events.

## Permissions

Permissions are defined in [seeder](https://github.com/EscolaLMS/Topic-Type-Project/blob/main/database/seeders/TopicTypeProjectPermissionSeeder.php).