/kuro-monsters-api

API to take care of monsters by feeding them.

Primary LanguagePHPMIT LicenseMIT

kuro-monsters-api

This API is about taking care of monsters.

Create a monster and be careful with this:

Every 10 minutes monsters increase their hunger by 1 and lost their energy by 5.

You have to feed them if you don't want them to die.

When hunger is at 100 they start to lose their life by 10 every 10 minutes, when life is 0 they die.

If monster lost all their energy they have to rest until they restore all their energy, meanwhile, you cannot feed them.

Docker image

You can run this project with a docker image

Host and Bearer Token Variables

Most of the requests need a Bearer Token, you can create one with the Register request.

See the docs

Run in Postman

Quick Setup

You can run this web app on your machine, just follow these steps:

  1. git clone https://github.com/kuro-vale/kuro-monsters-api.git
  2. cd kuro-monster-api
  3. composer install
  4. Create a .env, use .env.example as reference.
  5. When connected your database run php artisan migrate
  6. php artisan serve
  7. To run scheduled jobs create a custom cron that run php ~/kuro-monsters-api/artisan schedule:run every 10 minutes