Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 3.11 KB

README.md

File metadata and controls

100 lines (68 loc) · 3.11 KB
Raw

CodersCamp2020 Project TypeScript

Board game by BraveSquirrels

The third project in the 6th edition of the CodersCamp 2020 programming course.

The project is a browser version of a role-playing board game inspired by the game "Escape Tales"

The project team

Mentor: Kamil Zasada

Team:

The project uses:

basic types
defining own types
types / classes / interfaces
implementation / inheritance / composition / implementation of the interface
access modifiers
generic types
unit tests and TDD

The design template can be seen on Figma

Task board

You can find all the stuff about the project on the board Trello.

Technologies

Project is created with:

  • HTML5
  • SCSS
  • TypeScript
  • Node.js
  • jest

Setup

If you want to visit our webpage, just click here! WARNING Github will not open this link in a new tab, you have to do it manually.

To run the project locally follow these steps:

  • Clone this repository
  • Open repository in your code editor
  • Run command npm run prod
  • Run command npm run dev
  • Enter the local host that was created which by default is http://localhost:1234/

Walkthrough

Working version of the site here -> https://brave-squirrels.github.io/CodersCamp2020.Project.TypeScript.Her/

Her - start screen Her - start screen Her - start screen

Working with the project

Commit Message

We take the following format commit message

<type>: <commit_message>

Commit Message Type

  • build:A change that affects project building or external dependencies
  • docs: Change in documentation or additional materials
  • feature:Introducing new functionality
  • bugfix: Bug fix
  • refactor: A design change that doesn't fix or add anything

Commit Message rules

  • use the imperative present tense form: "change", not "changed" or "changes"
  • do not start with a capital letter
  • do not add a period at the end of the sentence
  • use English
  • format the code (shortcut ctrl + shift + F)

Pull Request

We work on branches in the branch per feature methodology. We try to create small PR. The description of the PR should be precisely described what does he change. Each PR must be approved by at least one another person.