Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
basicallydan committed Nov 23, 2020
1 parent 84f7bdd commit f4e396c
Show file tree
Hide file tree
Showing 10 changed files with 5,824 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing to Conway's Game of Life in TypeScript

One of the aims of this project is to learn how best to implement a simple application in various languages which touches on the subject of variables, data structures, program flow and test- or behaviour-driven development.

With that in mind, potential contributors are encouraged to make suggestions on how to improve this repository to get it more in line with community guidelines or convention within the TypeScript programming community, and to make better use of the languages features.

If you do make any changes, however, please ensure that the tests are still passing before you make a pull request.

Thank you!
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Conways's Game of Life in TypeScript

This is an implementation of [Conway's Game of Life](http://en.wikipedia.org/wiki/Conway's_Game_of_Life) in TypeScript created as an exercise in test-driven TypeScript development. Created by [@basicallydan](https://github.com/basicallydan).

## The Game

Check out the game of life in your terminal by running `npm start`.

## Tests

Jest tests are in `src`, so you just need to run `npm test` to run them.

## Contributing

If you'd like to contribute, that's great and I encourage it - I do, however, also encourage reading the [contributing doc](https://github.com/conwaysgame/typescript/blob/master/contributing.md) first. The golden rule for contributing is that **you ensure that the tests are still passing before you make a pull request.**

## Installation issues

* Using `yarn` to install `ts-jest` seems to cause problems when compiling native parts of the module. Use `npm install -D ts-jest` instead.
8 changes: 8 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
roots: ['<rootDir>/src'],
transform: {
'^.+\\.tsx?$': 'ts-jest',
},
testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
}
Loading

0 comments on commit f4e396c

Please sign in to comment.