Skip to content

KonradMierzejewski/CodersCamp2020.Project.TypeScript.YahtzeeGame

 
 

Repository files navigation

CodersCamp 2020 - TypeScript Project

The project was created as part of the 6th edition of the CodersCamp course.

Table of Contests

The project team

Authors of this project are course participants who worked under the supervision of an experienced mentor.

Authors:

Mentor: Filip Kuca

General info

Our project is an application to play dice game Yahtzee. This is a browser based web application, so no installation is required.

Features

  • The main page contains short introdution to a game and menu panel directing to Scores, Rules, Game and Authors.
  • Before each game, player is taken to the Settings, where he/she can choose how many playes would play. Maximum is four players and minimum is two players. Player can choose to play with a friends (on the same computer) or with computer. Computer has three difficulty levels - Easy/Hard/Medium. Player can mix game with computer/friends in the way he/she wants. Additionaly, in Settings panel player can choose style of the game - Classic Game / Play with Pirates / Beat the Dragon, which affects boardgame style and colours of dices.
  • Once the game starts, players and computers take they draws according to the rules of Yahtzee game. After each round, player can choose the categhory where the points from the draw would be assigned. Additionaly, scores table shows with green color which cathegory player can choose to gain points (green color) or which cathegory would get 0 points (red color). Points are being counted by the application.
  • During the game, when player clicks on the cathegory name the modal with a tip will be shown. While clicking on the points in any cathegory, modal with hostory of draws in this round will be shown.
  • After finishing the game, the player's score is summed up and all players scores are put it the ranking. It can be seen in Scores section.
  • Rules section shows rules of Yahtzee game.
  • Authors sections shows names of developers working on the application.
  • The application is responsive, so there is an option to display it on tablets and phones.

Technologies

  • HTML
  • SCSS
  • TypeScript
  • Webpack
  • BEM methodology
  • Jest
  • ESLint
  • StyleLint
  • HTML-validate
  • Scrum
  • Figma
  • Jira

Setup

Demo

To view a demo click here.

Getting started

If you want to run the application on the local machine, follow these steps:

  1. Clone down this repo
  2. Install dependencies with the command: yarn install
  3. Start development server yarn start

The application will be available at localhost:8080/#

Running tests

To run the application tests, follow these steps:

  1. Install dependencies with the command: yarn install (if you haven't already done so before)
  2. Run the tests by running the command: yarn test

Organization of work

Figma

Using Figma, we created our own prototype of a user interface adapted to Desktop, and also made a version adapted to display on Phones. All designs can be viewed here.

Jira

We also used Jira, where we organized all our work. More precisely, we shared responsibilities for each sprint, exchanged comments and approved our tasks.

About

Yahtzee Game - second group project on Coders Camp course.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 85.9%
  • SCSS 12.1%
  • JavaScript 1.8%
  • HTML 0.2%