Skip to content

HulaHop is a web platform dedicated to board games.

Notifications You must be signed in to change notification settings

KilianCM/HulaHop

Repository files navigation

HulaHop

Project information

HulaHop is a website dedicated to board games. It represents a fictitious company that allows you to borrow board games and receive them directly at home. The user returns the game at the end of the borrowing period. He can also find players near his home on a card and add them as friends to play board games.

Why "HulaHop" ?

Hula is the hawaian term for play. So we made a link between playing game and the famous toy HulaHoop.

Main features

In addition to offering a game lending system, HulaHop offers innovative features for board game fans.

Locate gamers

A HulaHop user have access to a Leaflet map with markers on it. These markers represent others players that ben be add as friend. An user can see the borrowed games of their friends to organise a party.

Best deals

HulaHop gives its users access to a list of games for sale with great discount value. This game data is provided by the Board Game API.

Technical information

Requirements

How to use it ?

To launch the project for dev purpose, you have to launch these commands :

With Docker

docker-compose up -d
docker-compose exec php bash -c "npm i && npm rebuild node-sass && npm run build"

Without Docker

  • Launch PHP server :
composer i
symfony serve
  • Launch yarn server (front) :
yarn
yarn run encore dev --watch
  • (only once) Create database :
php bin/console doctrine:create:database
php bin/console doctrine:migrations:migrate
php bin/console doctrine:fixtures:load //To populate database with 20 games and 1 category

Photon API

This project use the Photon API to transform postal address to geocoordinates. The API is free and doesn't require any key.

Board Games API

This project use the Board Game API to get games list with prices. This API require to create a free account and an application to get a CLIENT_ID. You need to set the BOARD_GAMES_CLIENT_ID env var with it.