Customize boilerplate for project

master
Tanner Collin 7 years ago
parent 85f374aed3
commit 99443e25de
  1. 4
      .gitignore
  2. 2
      LICENSE
  3. 47
      README.md
  4. 2
      index.html
  5. 25
      package.json

4
.gitignore vendored

@ -1,3 +1,5 @@
dist
node_modules
npm-debug.log
.DS_Store
*.swp
*.swo

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2014 Dan Abramov
Copyright (c) 2016 Tanner Collin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

@ -1,47 +0,0 @@
react-hot-boilerplate
=====================
The minimal dev environment to enable live-editing React components.
### Usage
```
npm install
npm start
open http://localhost:3000
```
Now edit `src/App.js`.
Your changes will appear without reloading the browser like in [this video](http://vimeo.com/100010922).
### Linting
This boilerplate project includes React-friendly ESLint configuration.
```
npm run lint
```
### Using `0.0.0.0` as Host
You may want to change the host in `server.js` and `webpack.config.js` from `localhost` to `0.0.0.0` to allow access from same WiFi network. This is not enabled by default because it is reported to cause problems on Windows. This may also be useful if you're using a VM.
### Missing Features
This boilerplate is purposefully simple to show the minimal configuration for React Hot Loader. For a real project, you'll want to add a separate config for production with hot reloading disabled and minification enabled. You'll also want to add a router, styles and maybe combine dev server with an existing server. This is out of scope of this boilerplate, but you may want to look into [other starter kits](https://github.com/gaearon/react-hot-loader/blob/master/docs/README.md#starter-kits).
### Dependencies
* React
* Webpack
* [webpack-dev-server](https://github.com/webpack/webpack-dev-server)
* [babel-loader](https://github.com/babel/babel-loader)
* [react-hot-loader](https://github.com/gaearon/react-hot-loader)
### Resources
* [Demo video](http://vimeo.com/100010922)
* [react-hot-loader on Github](https://github.com/gaearon/react-hot-loader)
* [Integrating JSX live reload into your workflow](http://gaearon.github.io/react-hot-loader/getstarted/)
* [Troubleshooting guide](https://github.com/gaearon/react-hot-loader/blob/master/docs/Troubleshooting.md)
* Ping dan_abramov on Twitter or #reactjs IRC

@ -3,7 +3,7 @@
<meta charset="UTF-8">
<meta name="fragment" content="!">
<title>React boilerplate</title>
<title>Notify</title>
<![if lt IE 10]>
<script src="/assets/js/es5-shim.min.js"></script>

@ -1,32 +1,13 @@
{
"name": "react-hot-boilerplate",
"name": "notify",
"version": "1.0.0",
"description": "Boilerplate for ReactJS project with hot code reloading",
"description": "",
"scripts": {
"start": "node server.js",
"lint": "eslint src"
},
"repository": {
"type": "git",
"url": "https://github.com/gaearon/react-hot-boilerplate.git"
},
"keywords": [
"react",
"reactjs",
"boilerplate",
"hot",
"reload",
"hmr",
"live",
"edit",
"webpack"
],
"author": "Dan Abramov <dan.abramov@me.com> (http://github.com/gaearon)",
"author": "Tanner Collin (http://github.com/tannercollin)",
"license": "MIT",
"bugs": {
"url": "https://github.com/gaearon/react-hot-boilerplate/issues"
},
"homepage": "https://github.com/gaearon/react-hot-boilerplate",
"devDependencies": {
"babel-core": "^5.4.7",
"babel-eslint": "^3.1.9",

Loading…
Cancel
Save