README.md

KikooLoL Server

Description

KikooLoL is a school project made for Need For School by the onRuntime Studio's team.

This project aims to create a gaming platform where League of Legends players can see their statistics and compare them with their friends. So they can improve their skills and become the best.

To see the documentation, start the server and go to the /docs page, there is a Swagger documentation that register every endpoints of this API.

Getting Started

Prerequisites

For this project we installed:

* Symfony 5.4
* Apache 2.4.41
* PHP >= 8.x.x
* MongoDB Server

Implementation Details

2. Using bundles:

   * FOSRestBundle
   * JMSSerializerBundle
   * NelmiCorsBundle
   

Installation

1. Clone the repo

git clone https://github.com/needforschool/kikoolol-server

2. Install Composer packages

composer install

3. Create a .env.local file and add your riot api key

RIOT_API_KEY=RGAPI-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Then go to .env and set your database informations (only MongoDB)

DATABASE_URL=database_url
MONGODB_DB=database_name

3. Initialize the database

php bin/console doctrine:database:create

php bin/console doctrine:schema:update --force

4. Run the server

symfony server:start

Contributing

Please see our contributing rules.

Authors

• Antoine Kingue (@antoinekm)
• Jérémy Baudrin (@jerembdn)

License

KikooLoL Server is MIT licensed.