https://github.com/escolalms/tags

General Tagging for any Module
https://github.com/escolalms/tags

api-rest laravel tagging

Last synced: 4 days ago
JSON representation

General Tagging for any Module

• Host: GitHub
• URL: https://github.com/escolalms/tags
• Owner: EscolaLMS
• License: mit
• Created: 2021-04-26T07:45:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T05:15:07.000Z (4 months ago)
• Last Synced: 2024-09-22T06:46:16.891Z (about 2 months ago)
• Topics: api-rest, laravel, tagging
• Language: PHP
• Homepage:
• Size: 33.5 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tags

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

[![codecov](https://codecov.io/gh/EscolaLMS/Tags/branch/main/graph/badge.svg?token=ci4VPQbrOI)](https://codecov.io/gh/EscolaLMS/Tags)

[![phpunit](https://github.com/EscolaLMS/Tags/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/Tags/actions/workflows/test.yml)

[![downloads](https://img.shields.io/packagist/dt/escolalms/tags)](https://packagist.org/packages/escolalms/tags)

[![downloads](https://img.shields.io/packagist/v/escolalms/tags)](https://packagist.org/packages/escolalms/tags)

[![downloads](https://img.shields.io/packagist/l/escolalms/tags)](https://packagist.org/packages/escolalms/tags)

[![Maintainability](https://api.codeclimate.com/v1/badges/f235cc5ffdde4318a4a0/maintainability)](https://codeclimate.com/github/EscolaLMS/Tags/maintainability)

## Features

The lib allows tags

- adding tags to each module

- edit and create multiple tags

See [Swagger](https://escolalms.github.io/Tags/) documented endpoints.

Some [tests](tests) can also be a great point of start.

To play the content you can use [EscolaLMS Tags](https://github.com/EscolaLMS/Tags)

## Install

1. `composer require escolalms/tags`

2. `php artisan migrate`

### Cors

All the endpoints need to be accesible from other domains, so [CORS](https://laravel.com/docs/8.x/routing#cors) must be properlly set.

Except of endpoints assets must expose CORS headers as well. You achive that by setting Apache/Nginx/Caddy/Whatever settings - below is example for Nginx for wildcard global access.

```

location ~* \.(eot|ttf|woff|woff2|jpg|jpeg|gif|png|wav|mp3|mp4|mov|ogg|webv)$ {

    add_header Access-Control-Allow-Origin *;

}

```

### Seeder

You can seed library and content with build-in seeders that are accessible with

- `php artisan tag-permissions:seed` to add permissions

## Road map

- caching

- casading delete

- sql foreign keys indexing

- clearup task - deleting temp files, marked for delete