Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 1.63 KB

README.md

File metadata and controls

79 lines (52 loc) · 1.63 KB

KGames

KGames is a rough copy of the official (game) website of Kameto Corp. under ReactJS, NodeJS (with PostgreSQL database), GraphQL and Websocket technologies.

KGames enables you to own your game server and client with all the games available on the official website of Kgames. You can update the database your self so you can have specific question adapted to your group of friends.

Features

By now, the features of KGames we're focusing:

  • User session
    • Login through Google account
    • Login through Twitch account
  • Room session
  • Lobby management (Connection/Disconnection/Configuration/Game select).
  • Games server API
  • Games
    • KCulture
    • Geoquizz
    • Undercover
    • Spyfall
    • Imposter

How to Contribute

Get the code

Requires npm or yarn.

git clone  https://github.com/thomasDelaporte/KGames.git
cd KGames
npm install

Start the dev server

To work on the project, you should have one CLI for the server and another one for the web client.

Before running commands below, you need to build the common package:

npm run common:build

You'll need to create an .env file for web and server package based on the env.example file given.

Main commands that you'll use for development:

npm run web:dev
npm run server:dev

Build the app

To build the projet you have the commands:

npm run web:build
npm run server:build

Contributing

Contributions and feed back are welcome following Github workflow.

License

KGames is provided under the MIT license.