https://github.com/danekf/league-api-playground
A project to play with the Riot API.
https://github.com/danekf/league-api-playground
Last synced: about 1 year ago
JSON representation
A project to play with the Riot API.
- Host: GitHub
- URL: https://github.com/danekf/league-api-playground
- Owner: danekf
- Created: 2022-10-28T18:08:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-09T20:18:35.000Z (over 3 years ago)
- Last Synced: 2025-01-25T16:32:24.646Z (over 1 year ago)
- Language: TypeScript
- Size: 224 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LeagueApiPlayground
## The "what"
This project will be an exploration of using the riot api. Starting goal is to create seperate widgets that can then be expanded to display extra information.
## Generating a key
In order to generate a key to use the Riot API, visit the [Riot developper website](https://developer.riotgames.com/).
## Set api key in environment
Rename "/src/environments/apiKeys.example" to apiKeys.ts and insert your API key generated in previous step, where indicated.
## Updating the champion pool.
In the apiKeys.ts file, there is a CURRENT_CHAMPION_LIST. This pulls JSON data for all champions in league at a current patch. This will need to be updated as patches come out, especially when new champions are released.
## Project Roadmap
- [] - Setup environment variables for API key
- [] - Create component for a single search
- [] - Load static info with search parameter
- [] - Create layout for a basic widget
- [] - Add ability to modify search input
- [] - Add expand option for widget to show more info
- [] - Load static info with search parameter
- [] - Create second component for a different search (modeled on first component)
- [] - Play and expand further
### *↓↓ below to be removed at a later date ↓↓*
# Angular default Readme stuff
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
## Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.