Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eugene-matvejev/typescript-battleship

GUI for https://github.com/eugene-matvejev/symfony-battleship
https://github.com/eugene-matvejev/typescript-battleship

battleship-game javascript jquery sass typescript

Last synced: about 1 month ago
JSON representation

GUI for https://github.com/eugene-matvejev/symfony-battleship

Host: GitHub
URL: https://github.com/eugene-matvejev/typescript-battleship
Owner: eugene-matvejev
Created: 2016-02-19T17:28:06.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2022-12-06T20:06:19.000Z (about 2 years ago)
Last Synced: 2023-03-03T18:28:29.944Z (almost 2 years ago)
Topics: battleship-game, javascript, jquery, sass, typescript
Language: TypeScript
Homepage:
Size: 402 KB
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        
[circle.ci-master-badge]: https://circleci.com/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/tree/master.svg?style=svg

[circle.ci-master-link]: https://circleci.com/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/tree/master

[codecov.io-master-badge]: https://codecov.io/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/branch/master/graph/badge.svg

[codecov.io-master-link]: https://codecov.io/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/branch/master

[circle.ci-heroku-badge]: https://circleci.com/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/tree/heroku.svg?style=svg

[circle.ci-heroku-link]: https://circleci.com/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/tree/heroku

[codecov.io-heroku-badge]: https://codecov.io/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/branch/heroku/graph/badge.svg

[codecov.io-heroku-link]: https://codecov.io/gh/eugene-matvejev/battleship-game-gui-vanilla-typescript/branch/heroku

|                       | master                                                         | heroku

|---                    |---                                                             |---

| __compilation__       |

| _< Circle CI >_ TSC   | [![build][circle.ci-master-badge]][circle.ci-master-link]      | [![build][circle.ci-heroku-badge]][circle.ci-heroku-link]

| _< Circle CI >_ LESSC | [![build][circle.ci-master-badge]][circle.ci-master-link]      | [![build][circle.ci-heroku-badge]][circle.ci-heroku-link]

| __coverage__          |

| _< codecov.io >_      | [![coverage][codecov.io-master-badge]][codecov.io-master-link] | [![coverage][codecov.io-heroku-badge]][codecov.io-heroku-link]

# Battleship Game GUI on vanilla TypeScript

GUI for [Battleship Game API](https://github.com/eugene-matvejev/symfony-battleship), __[DEMO](https://battleship-game-gui-typescript.herokuapp.com/)__

##### THIS IS SPARE TIME PROJECT, WORK IN PROGRESS! HIGHLY EXPERIMENTAL!!!

#### project purpose:

 * try out "cutting edge" technologies and approaches such as TypeScript, ES6, Service Workers and Continuous Integration|Deployment

 * try out single-page-application [SPA] aproach

 * try out cross-browser requests

 * deliver preview about my technical knowledge before the job interview

#### game cheat-code:

_purpose: easier manual testing_

* AI player have only one ship, which is one-cell ship which and located at __B2__ cell

  * if you will hit __B2__ cell - you will win

# workflow

 * new functionality is added into master branch only by pull requests

 * result of each pull request is ready-to-use release, using Continuous Delivery principles

 * pull requests are named using semantic visioning

 * __gitflow__

   * master branch: stable, contains release-ready source

   * heroku branch: reflects current deployed app at heroku (prototype of Continuous Delivery|Deployment)

   * prototype_* branches contains new idea [merged pull request of prototype branch is always next *major* version release]

   * pull requests follows [semantic vesion](http://semver.org/)

# technology side

### software requirements

 * TypeScript 2.0+ Compiler [TSC]

 * LESS Compiler

 * node.js v6.9+

 * npm v3.8+ or yarn v0.21+

### key technologies

 * TypeScript 2.0

 * JavaScript ES6 [ECMAScript6]

 * LESS

 * CSS3

 * DefinitelyTyped

 * Twitter Bootstrap 3

 * jQuery 2

 * yarn

 * npm

### used patterns

 * MVC

 * Builder

 * Delegation

 * Registry

 * Event Dispatcher

 * Dependency Injection

# how to use

### how to install _[for development]_

 * `$ npm install` or if you have __yarn__ installed locally - `$ yarn install` will fetch local, and global dependencies

   * node.js _LESS_ compiler [lessc]

   * node.js lite server

 * `src/js/configuration.storage.ts` contains settings for the webapp

### static mode

 * `$ npm run generate:all` - will compile project css|configs|js from the sources

### how to execute tests

 * WIP

### /etc/hosts

```

127.0.0.1        game-gui-vanilla-typescript.game.local

::1              game-gui-vanilla-typescript.game.local

```

### apache virtual host config

```

    DocumentRoot "%PROJECT_ROOT_DIRECTORY%/web"

    ErrorLog "%PROJECT_ROOT_DIRECTORY%/var/logs/apache_log"

    ServerName game-gui-vanilla-typescript.game.local

    ServerAlias game-gui-vanilla-typescript.game.local

    

        AllowOverride All

        Order Allow,Deny

        Allow from All

        Require all granted

    

```