README.md

League

What goes here? I don't know.

I realize someone else should have written the description.

Getting Started

• Make sure you have your own League API key, be aware these expire every two days so if your requests are responding with 404 make sure you have a valid key.
• You must have a League account in order to get an API key
• Get key
• Store your keys in your own secrets.js file -> process.env.LEAGUE_API_KEY = "your league key"

Prerequisites

• A LoL account is needed in order to obtain a LoL API key.

Running the tests

npm run test to run all available test. You can also run a specific test

npm run test #runs all the tests
npm run test-champion-routes # runs tests for champion routes

Api routes and testing

• As you make API routes make sure to write out tests and include the test run script in package.json. All though more time consuming on initial setup it will speed up development when we don't have to manually test each time.

Components and Tests

• As you make components make sure to write out tests and include the test run script in package.json. All though more time consuming on initial setup it will speed up development when we don't have to manually test each time.

Built With

• LoL API

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

Currently in development process. Versions are not yet available.

Perhaps when the project is more developed we will use SemVer for versioning.

Authors

• Yu Lin - Initial work - niLYu

• Jack Jiang - Initial work - thejackjiang

• Sulamita Morales - Initial work - kyusulamita

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Virtual cookie for everyone who's code was used
• Inspiration
• LoL API
• Jack for checking to make sure everyone is alive
• Yu for his savage comments
• Actually they're both pretty savage T-T
• Sulamita wasn't actually a part of this project at all...