Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jlenon7/athenna-riot-api

Athenna application that consumes Riot API and saves the Summoner data in database.
https://github.com/jlenon7/athenna-riot-api

Last synced: 9 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/jlenon7/athenna-riot-api
Owner: jlenon7
Created: 2024-01-06T21:33:05.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-02-10T21:02:39.000Z (11 months ago)
Last Synced: 2024-10-05T23:41:40.091Z (3 months ago)
Language: TypeScript
Size: 832 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # AthennaIO 🦴

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

[![GitHub followers](https://img.shields.io/github/followers/athennaio.svg?style=social&label=Follow&maxAge=2592000)](https://github.com/athennaio?tab=followers)

[![GitHub stars](https://img.shields.io/github/stars/athennaio/athennaio.svg?style=social&label=Star&maxAge=2592000)](https://github.com/athennaio/athennaio/stargazers/)



    





  

  

  

  





## Running

First go to the [Riot developer portal](https://developer.riotgames.com/) 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:

```shell

docker-compose up -d

```

Install dependencies:

```shell

npm install

```

Create `.env` and `.env.test`

```shell

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

```

Run database migrations:

```shell

node artisan migration:run

```

To run your application in watch mode:

```shell

node artisan serve --watch

```

Visit [http://localhost:3000/docs](http://localhost:3000/docs)

to see the Swagger documentation page.

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

```shell

node artisan test

```

## Links

> For project documentation [click here](https://athenna.io). If something is not clear in the documentation please open

> an issue in the [documentation repository](https://github.com/athennaio/docs)

## Contributing

> If you want to contribute to this project, first read

> the [CONTRIBUTING.MD](https://github.com/AthennaIO/AthennaIO/blob/develop/CONTRIBUTING.md) file. It will be a pleasure to

> receive your help.

---



  With 💜 by Athenna community