Skip to content

DanielWidmayer/swabianGaigel

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

Gaigel Webapp

An awesome way to play Gaigel with your friends online, for free & without registration!

Play Now · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. How to play
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

Gaigel is a traditionally swabian card game. However there is no website to play Gaigel online with your friends. This project implements a simple way to play Gaigel online. Its simple and easy. You don't need to register, just hop in and play.

🎮 Here's why you should play:

  • Play with your friends if you can't meet personally
  • Flexible to Use: no account needed
  • Free to Play (and no hidden ads, tracking or ingame purchases)
  • Open Source: Simply improve the game by collaborating if you find any issues

Built With

Getting Started

Please note: This branch should only be used for local deployment and development as it's using the native sails-disk engine and in-memory store which should not be used in the production environment. Please refer to the other branches if you want to deploy this application: The deploy branch covers the deployment on Heroku and the deploy-docker branch covers the deployment using Docker Containers. Of course you can always feel free to edit the code from this branch and deploy the way you like to, those are just examples on how we managed it.

To get a local copy up and running follow these simple steps.

Prerequisites

First of all you should make sure that you have the latest version of Node.js installed. You can check your version with:

node -v

if your version is not up-to-date we would recommend updating to the newest version either via Node Version Manager, which can be found here: https://github.com/nvm-sh/nvm (or here: https://github.com/coreybutler/nvm-windows for Windows respectively), or by downloading the pre-built installer from https://nodejs.org/en/download/.

After you have installed Node.js and/or verified the installation, you can proceed to install Sails.js globally via npm

npm install sails -g

These are the only two prerequisites you will need to run this application locally.

Installation

  1. Clone the repo
git clone https://github.com/DanielWidmayer/swabianGaigel.git
  1. Install required dependencies via npm
npm install
  1. Run the server
sails lift

How to play

For a complete Tutorial on how to play and the game rule set with pictures, please refer to the available Website.

Roadmap 🚀

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Daniel Widmayer - inf18157@lehre-dhbw-stuttgart.de
Jens Buehler - inf18145@lehre.dhbw-stuttgart.de

Project Link: https://github.com/DanielWidmayer/swabianGaigel

Acknowledgements