add important notes and files

This commit is contained in:
Kent C. Dodds 2016-07-29 19:29:45 -06:00
parent 54653e224e
commit 42002931fb
5 changed files with 64 additions and 10 deletions

View File

@ -1,5 +1,14 @@
{
"extends": ["kentcdodds", "kentcdodds/mocha", "kentcdodds/webpack"],
"extends": [
"kentcdodds/best-practices",
"kentcdodds/possible-errors",
"kentcdodds/es6/best-practices",
"kentcdodds/es6/possible-errors",
"kentcdodds/import/best-practices",
"kentcdodds/import/possible-errors",
"kentcdodds/mocha",
"kentcdodds/webpack",
],
"rules": {
// these are only here because I did not
// want to update the entire codebase ¯\_(ツ)_/¯
@ -15,6 +24,7 @@
"id-match": 0,
"import/newline-after-import": 0,
// es6 stuff we technically can not do yet
"strict": 0,
"object-shorthand": 0,
"prefer-arrow-callback": 0,
"prefer-template": 0,

2
.gitattributes vendored Normal file
View File

@ -0,0 +1,2 @@
* text=auto
*.js text eol=lf

8
LICENSE Normal file
View File

@ -0,0 +1,8 @@
The MIT License (MIT)
Copyright (c) 2016 Kent C. Dodds
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.

View File

@ -4,8 +4,8 @@
"todomvc-app-css": "2.0.6"
},
"devDependencies": {
"eslint": "3.1.1",
"eslint-config-kentcdodds": "^8.1.3",
"eslint": "3.2.2",
"eslint-config-kentcdodds": "^9.0.0",
"ghooks": "1.3.2",
"http-server": "0.9.0",
"opt-cli": "1.5.1"

View File

@ -2,9 +2,12 @@
## Purpose
This was originally part of [an ES6 training](bit.ly/es6-intro-slides) by [Kent C. Dodds](https://twitter.com/kentcdodds)
This was originally part of [an ES6 training](http://kcd.im/es6-intro-slides) by [Kent C. Dodds](https://twitter.com/kentcdodds)
Now I'm using it to teach people about [Webpack](http://webpack.github.io/).
Now I'm using it to teach people about [Webpack](http://webpack.github.io/):
- [Egghead.io lessons](http://kcd.im/egghead-webpack)
- [Frontend Masters](http://kcd.im/fem-webpack)
## Thanks
@ -12,8 +15,39 @@ This codebase was originally taken from the TodoMVC project starting [here](http
## Project Setup
1. Fork the GitHub Repo
2. Clone your Fork
3. Run `npm install`
4. Run `npm run validate`
5. If everything's running without errors, you can start checking out the available branches (`git remote show origin`)
This project assumes you have [NodeJS v6](http://nodejs.org/) or greater installed. You should
also have [npm v3](https://www.npmjs.com/) or greater installed as well (this comes packaged
with Node 6). You'll also need a recent version of [git](https://git-scm.com/) installed
as well.
You may have come to this project from different varying sources. There are a
different series of branches for each workshop/course I've done. To get started with
the project, start with this:
1. [Sign up](https://github.com/join) for a GitHub Account (if you don't already have one)
2. [Fork](https://help.github.com/articles/fork-a-repo/) this repo
3. [Clone](https://help.github.com/articles/cloning-a-repository/) your fork
4. In the directory you cloned the repository, run `git fetch --all`
If you need help with these steps, you might check out
[this free Egghead.io course](http://kcd.im/pull-request) which can help you get things going.
Finally, based on which version of the project you're looking for (workshop, egghead, or
Frontend Masters) you'll run one of the following commands in the cloned directory:
- **ES6 Workshop**: `npm run setup:workshop`
- **Egghead Course**: `npm run setup:egghead`
- **Frontend Masters Workshop**: `npm run setup:fem`
If you get any failures at this point something is wrong and needs to be fixed. Remember,
[Google](https://google.com) and [StackOverflow](https://stackoverflow.com) are your friends.
You might find it helpful to see a list of the available branches. Run: `git branch` for that.
## Notes
Because Webpack 2 is currently in beta, there are issues with `peerDependencies`, so youll have to use npm version 3 to be able to install the dependencies.
## LICENSE
MIT