escolalms/csv-users

Escola Headless LMS CSV Users

Maintainers

👁 qunabu

Package info

github.com/EscolaLMS/CSV-Users

Type:package

pkg:composer/escolalms/csv-users

Statistics

Installs: 11 919

Dependents: 2

Suggesters: 0

Stars: 0

Open Issues: 0

0.1.16 2024-02-05 13:58 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT 2c52b8bb7a9dac8435f1df8c4a353b2584366c6e

  • Maciej Rymarz <maciej.rymarz.woop@escolasoft.com>

README

👁 swagger
👁 codecov
👁 phpunit
👁 downloads
👁 downloads
👁 downloads
👁 Maintainability
👁 Test Coverage

What does it do

This package is used to export and import users in the .csv format.

Installation

  • composer require escolalms/csv-users
  • php artisan db:seed --class="EscolaLms\CsvUsers\Database\Seeders\CsvUsersPermissionSeeder"

Example

id name first_name last_name email country is_active created_at onboarding_completed email_verified interests avatar roles permissions path_avatar contact bio
16 Valentine Wehnner Valentine Wehnner jhyatt@example.net Poland 2021-10-14T15:50:28.000000Z TRUE TRUE LMS localhost/storage/avatars/16/logo.png ["tutor"] ["access dashboard"] avatars/16/logo.png 1234567 bio

  • Export uses fields from EscolaLms\Auth\Http\Resources\UserFullResource

  • Import uses the update or create method from EscolaLms\Auth\Repositories\Contracts\UserRepositoryContract. If the email exists in the database, the user's data is updated. Otherwise, a new user is created.

Endpoints

All the endpoints are defined in 👁 swagger

Tests

Run ./vendor/bin/phpunit to run tests. Test details 👁 codecov
👁 phpunit

Events

  • EscolaLms\CsvUsers\Events\EscolaLmsImportedNewUserTemplateEvent => Event is dispatched after importing a new user.

How to use this on frontend

Admin panel

Import and export button 👁 Import / export button

Permissions

Permissions are defined in seeder