Skip to content

Commit

Permalink
Add basic boilerplate code for javascript katas
Browse files Browse the repository at this point in the history
  • Loading branch information
Vicente Pons committed Sep 12, 2017
0 parents commit 9787b57
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM node:8.4.0-alpine

WORKDIR "/opt/katas"

RUN npm install -g jest

COPY . $WORKDIR

CMD ["jest", "--watchAll"]
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2017 Vicente Pons

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Boilerplate code for javascript katas
=====================================

This repository is a boilerplate code for using when we are going to start a new kata in javascript.

### Getting Started

In order to use it, we must install [docker](https://docs.docker.com/engine/installation/) to run it with a container, or install a standard node development environment and run it in your local machine.

To run the project with docker, we can do the following:

$ ./bin/start

Now, thanks to [jest](https://facebook.github.io/jest), every time we save a change, we'll see how the tests run automatically at the terminal.
11 changes: 11 additions & 0 deletions bin/start
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh
trap 'exit 1' SIGSEGV SIGTERM

docker build -t js-boilerplate .

docker run -it \
--rm \
--mount type=bind,source="$(pwd)",target=/opt/katas \
js-boilerplate

exit $?
Empty file added lib/.keep
Empty file.
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "kata name",
"jest": {
"verbose": true
}
}
5 changes: 5 additions & 0 deletions test/example.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
describe('Example', () => {
it('test the truth', () => {
expect(true).toBe(true);
});
});

0 comments on commit 9787b57

Please sign in to comment.