jlenon7 / athenna-riot-api

Athenna application that consumes Riot API and saves the Summoner data in database.

AthennaIO 🦴

The Athenna scaffold project used by 'athenna new project' command to create your project.

Running

First go to the Riot developer portal and get an API Key. Add your key to your .env and .env.test file in the RIOT_API_KEY env var.

In application root path, run Postgres database locally using the following command:

docker-compose up -d

Install dependencies:

npm install

Create .env and .env.test

cp .env.example .env && cp .env.example .env.test

Run database migrations:

node artisan migration:run

To run your application in watch mode:

node artisan serve --watch

Visit http://localhost:3000/docs to see the Swagger documentation page.

To run application tests (needs Database and API Key for E2E tests):

node artisan test

Links

For project documentation click here. If something is not clear in the documentation please open an issue in the documentation repository

Contributing

If you want to contribute to this project, first read the CONTRIBUTING.MD file. It will be a pleasure to receive your help.

---

With 💜 by Athenna community