search

marky291 / lit-timetables

Unofficial LIT Timetable application with notification channels, api platform, minimalistic views and mobile-first approach, solving problems as a student for students.
https://litcoursefinder.com
0 stars 0 forks source link

readme

LIT Timetables

Laravel Latest Version

Installation

Git pull this repository to a location of choice on your computer.

git clone https://github.com/marky291/lit-timetables.git

Download and use Composer, in the root of the project.

Composer Installation (Linux & MacOS)

composer install

Composer installation (Windows)

composer install --ignore-platform-reqs

Seed the database for local development

./vendor/bin/sail artisan db:seed

Or use live timetable data for testing

./vendor/bin/sail artisan relay:sync

Docker (Linux & MacOS)

Deploy the Laravel Docker Container for environment setup. If you are missing docker then you should install Docker

./vendor/bin/sail up

MeiliSearch

Meilisearch is an open-source search engine that powers the search in the application by default this is preconfigured with the laravel sail docker container and defined in the .env environment file.

MeiliSearch Installation (Linux & MacOS)

SCOUT_DRIVER=meiliesearch
SCOUT_QUEUE=true

Meiliesearch uses Laravel Scout as the engine driver.

Testing

php artisan test

Security

If you discover a security vulnerability please send an e-mail to Mark Hester via marky360@live.ie.

License

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