diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..0226668 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,9 @@ +FROM node:8.4.0-alpine + +WORKDIR "/opt/katas" + +RUN npm install -g jest + +COPY . $WORKDIR + +CMD ["jest", "--watchAll"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e23305b --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b26de29 --- /dev/null +++ b/README.md @@ -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. diff --git a/bin/start b/bin/start new file mode 100755 index 0000000..4b4a269 --- /dev/null +++ b/bin/start @@ -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 $? diff --git a/lib/.keep b/lib/.keep new file mode 100644 index 0000000..e69de29 diff --git a/package.json b/package.json new file mode 100644 index 0000000..1a9753d --- /dev/null +++ b/package.json @@ -0,0 +1,6 @@ +{ + "name": "kata name", + "jest": { + "verbose": true + } +} diff --git a/test/example.test.js b/test/example.test.js new file mode 100644 index 0000000..c5ce41e --- /dev/null +++ b/test/example.test.js @@ -0,0 +1,5 @@ +describe('Example', () => { + it('test the truth', () => { + expect(true).toBe(true); + }); +});