Merge branch 'master' into feature/codeclimate

lapanti · Aug 24, 2017 · cbc2539 · cbc2539
2 parents ca32001 + d84ad6b
commit cbc2539
Show file tree

Hide file tree

Showing 55 changed files with 4,438 additions and 1,119 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ dist/
 **/.vscode
 !**/.vscode/tasks.json
 yarn-error.log
+_book/
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,19 @@
 language: node_js
 node_js:
-  - "node"
-
+- node
 cache: yarn
-
-script: "yarn run test:ci"
-
-after_script: "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
+before_script:
+- yarn global add greenkeeper-lockfile
+- greenkeeper-lockfile-update
+script: yarn run test:ci
+after_script:
+- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
+- greenkeeper-lockfile-upload
+deploy:
+  provider: script
+  script: ./publish.sh
+  on:
+    branch: master
+before_install:
+- openssl aes-256-cbc -K $encrypted_5a1a1505749b_key -iv $encrypted_5a1a1505749b_iv
+  -in deploy_key.enc -out deploy_key -d
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+ts-react-boilerplate.js.org
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Contribution guidelines
+
+All contributions are more than welcome!
+
+1. Check the [issues](https://github.com/Lapanti/ts-react-boilerplate/issues) in case someone has already thought about the cool thing you want to contribute
+    - If not, create an issue about it (*we will try to answer to your issue asap*)
+2. Start working on a proposed solution by following the [development](https://github.com/Lapanti/ts-react-boilerplate#development) guide.
+3. Wait for our comments and/or review
+4. Thank you for contributing!
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -0,0 +1,7 @@
+*Make sure the title is descriptive*
+
+This is a feature request/bug report/something else
+
+Add a short description
+
+I will create a PR with the solution / I need help to create a PR / I don't have the time/skills to create a PR
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,10 @@
+*All PRs should be based on an issue*
+**WHY?**
+See issue # / A short description
+**WHAT?**
+A short description of the changes
+
+- [ ] I have considered (and possibly added) tests
+- [ ] I have updated the documentation (gitbook)
+
+[Optional] Resolves #
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
 # A very opinionated frontend boilerplate
-[![Build Status](https://travis-ci.org/Lapanti/ts-react-boilerplate.svg?branch=master&style=flat)](https://travis-ci.org/Lapanti/ts-react-boilerplate) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat)](https://opensource.org/licenses/MIT) [![Dependency Status](https://david-dm.org/lapanti/ts-react-boilerplate.svg?style=flat)](https://david-dm.org/lapanti/ts-react-boilerplate) [![DevDependency Status](https://david-dm.org/lapanti/ts-react-boilerplate.svg?type=dev&style=flat)](https://david-dm.org/lapanti/ts-react-boilerplate?type=dev) [![Coverage Status](https://coveralls.io/repos/github/Lapanti/ts-react-boilerplate/badge.svg?branch=master&style=flat)](https://coveralls.io/github/Lapanti/ts-react-boilerplate?branch=master) [![Code Climate](https://img.shields.io/codeclimate/github/Lapanti/ts-react-boilerplate.svg?style=flat-square)](https://codeclimate.com/github/Lapanti/ts-react-boilerplate) [![Code Climate](https://img.shields.io/codeclimate/issues/github/Lapanti/ts-react-boilerplate.svg?style=flat-square)](https://codeclimate.com/github/Lapanti/ts-react-boilerplate/issues)
+
+[![Greenkeeper badge](https://badges.greenkeeper.io/Lapanti/ts-react-boilerplate.svg)](https://greenkeeper.io/)
+[![Build Status](https://img.shields.io/travis/Lapanti/ts-react-boilerplate/master.svg?style=flat-square)](https://travis-ci.org/Lapanti/ts-react-boilerplate) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT) [![Dependency Status](https://david-dm.org/lapanti/ts-react-boilerplate.svg?style=flat-square)](https://david-dm.org/lapanti/ts-react-boilerplate) [![DevDependency Status](https://img.shields.io/david/dev/lapanti/ts-react-boilerplate.svg?style=flat-square)](https://david-dm.org/lapanti/ts-react-boilerplate?type=dev) [![Coverage Status](https://img.shields.io/coveralls/Lapanti/ts-react-boilerplate/master.svg?style=flat-square)](https://coveralls.io/github/Lapanti/ts-react-boilerplate?branch=master)[![Code Climate](https://img.shields.io/codeclimate/github/Lapanti/ts-react-boilerplate.svg?style=flat-square)](https://codeclimate.com/github/Lapanti/ts-react-boilerplate) [![Code Climate](https://img.shields.io/codeclimate/issues/github/Lapanti/ts-react-boilerplate.svg?style=flat-square)](https://codeclimate.com/github/Lapanti/ts-react-boilerplate/issues)
 
 ## Purpose
 
-This is all you need to get started in developing your own web application, using TypeScript, React, server-side rendering and all the other hip tools. All the source code is well-documented and explains its purpose. You can read the [getting started guide here](#getstarted)
+This is all you need to get started in developing your own web application, using TypeScript, React, server-side rendering and all the other hip tools. If you know what you are doing, you can follow the [quick start guide](#quickstart) or you can go learn with the walk-through starting [here](/docs/STRUCTURE.md).
 
 ## Contents
-- [Getting started](#getstarted)
+- [Quick start guide](#quickstart)
     - [Requirements](#requirements)
     - [Download the source code](#download)
     - [Starting development](#startingdevelopment)
@@ -19,7 +21,7 @@ This is all you need to get started in developing your own web application, usin
     - [Roadmap](#roadmap)
 - [License and contact information](#license)
 
-## <a name="getstarted">Getting started</a>
+## <a name="quickstart">Quick start guide</a>
 
 ### <a name="requirements">Requirements</a>
 - If you don't already have it, install [Node](https://nodejs.org/en/download/)
@@ -45,11 +47,11 @@ This is all you need to get started in developing your own web application, usin
 ## <a name="tipsandsuggestions">Tips and suggestions</a>
 - Make sure everything has a type (the more you squeeze out of the compiler the easier you're going to have it while developing)
 - Follow [BEM](http://getbem.com/naming/)-naming with CSS
-- Follow [Redux-ducks pattern](https://github.com/erikras/ducks-modular-redux) except that name the reducers as according to the file (see [IndexReducer.tsx](src/modules/index/IndexReducer.tsx) for an example)
+- Follow [Redux-ducks pattern](https://github.com/erikras/ducks-modular-redux) except that name the reducers as according to the file (see [IndexReducer.tsx](/src/modules/index/IndexReducer.tsx) for an example)
 
 ## <a name="dockerization">How to Docker</a>
-The [Dockerfile](Dockerfile) is where you can find the configuration to build a [Docker](https://www.docker.com/) image out of your application. The first line of the `Dockerfile` (starting with `FROM`) includes the base for your Dockerfile, feel free to change it if you want to.
-1. Put your email to the [fourth line in the Dockerfile](Dockerfile#L4)
+The [Dockerfile](/Dockerfile) is where you can find the configuration to build a [Docker](https://www.docker.com/) image out of your application. The first line of the `Dockerfile` (starting with `FROM`) includes the base for your Dockerfile, feel free to change it if you want to.
+1. Put your email to the [fourth line in the Dockerfile](/Dockerfile#L4)
 2. In your console run `docker build .`
 3. In your console run `docker run -d -p 8080:8080 bd9b1d6725bc` **but** replace `bd9b1d6725bc` with the image ID you received from the previous command
 4. Host your Docker image in your favorite cloud or local server (the web is filled with guides for this)
@@ -80,7 +82,7 @@ The following are all the dependencies of the project, with the reasoning behind
 - :two_hearts: [concurrently](https://github.com/kimmobrunfeldt/concurrently) to run multiple script concurrently
 
 ## <a name="contributing">Contributing</a>
-First read the (as-of-yet-nonexistent) CONTRIBUTING guideline
+Read the [contribution guidelines](./CONTRIBUTING.md)
 
 ### <a name="development">Development</a>
 1. Clone this repo (or fork and clone)

diff --git a/SUMMARY.md b/SUMMARY.md
@@ -0,0 +1,17 @@
+# Table of contents
+
+* [README](/README.md)
+
+### Walk-through
+
+* [Application structure](/docs/STRUCTURE.md)
+* [Common](/docs/COMMON.md)
+* [Components](/docs/COMPONENTS.md)
+* [Redux](/docs/REDUX.md)
+* [Views](/docs/VIEWS.md)
+* [Reducers](/docs/REDUCERS.md)
+* [Containers](/docs/CONTAINERS.md)
+* [Completing React](/docs/COMPLETING.md)
+* [Styles](/docs/STYLES.md)
+* [Testing](/docs/TESTING.md)
+* [Extras](/docs/EXTRAS.md)
diff --git a/book.json b/book.json
@@ -0,0 +1,17 @@
+{
+    "gitbook": "^3.1.1",
+    "title": "TS-React-Boilerplate",
+    "plugins": ["edit-link", "prism", "anker-enable", "github", "advanced-emoji", "-sharing"],
+    "pluginsConfig": {
+        "theme-default": {
+            "showLevel": false
+        },
+        "edit-link": {
+            "base": "https://github.com/Lapanti/ts-react-boilerplate/tree/master",
+            "label": "Edit this page"
+        },
+        "github": {
+            "url": "https://github.com/Lapanti/ts-react-boilerplate"
+        }
+    }
+}
diff --git a/deploy_key.enc b/deploy_key.enc