npm install
npm run start
npm run build
npm run test:unit
npm run lint
http://localhost/todo/v1
This app runs on localhost port 8080, please change if there are conflicts with other services on your computer.
composer install
php artisan vendor:publish | Publish Sanctum, Swagger, Cloudinary Packages
Configure .env with corresponding Docker credentials. App should run on localhost.
docker compose up
docker exec -it std-app php artisan config:clear
docker exec -it std-app php artisan migrate --seed
docker exec -it std-app php artisan load:task
docker exec -it std-app php artisan l5-swagger:generate
docker exec -it std-app php artisan test
http://localhost/todo/docs
- REDIS has been configured for MailJobs & Queues, feel free to run different ports from Compose.
- Monitor your Queue with Supervisor (not compulsory).
- Users get reminded about their todos through scheduled messages, 1 hour before start time.
- Create a configuration file for the Scheduler and monitor with Supervisor.
- API Annotations were written and published with Swagger.
- API Authorization and Authentication powered by Sanctum.
- Cloudinary for Image Uploads.
- Design Pattern: Service-Repositories using Eloquent (This can be switched to use DB Transactions).
- This app does not cover Paginations, Empty States and Bash Aliases.