commit e12c7da6ed800df97c46932d8163e7afe47d7ce9
parent cdef7e523ec074f8dca97ba6c946e5dd3c436a55
Author: Konstantin Tarkus <hello@tarkus.me>
Date: Mon, 15 Sep 2014 09:16:58 +0400
Update README.md
Diffstat:
| M | README.md | | | 99 | +++++++++++++++++++++++++++++++++++++++++++++++++------------------------------ |
1 file changed, 62 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
@@ -4,78 +4,103 @@
> single-page application (SPA) based on Facebook React. You can use it
> to quickly bootstrap your web application projects. It contains only
> client-side components and development tools and is recommended to be
-> paired with a server-side project similar to [ASP.NET Server Template]
-> (https://github.com/kriasoft/AspNet-Server-Template).
+> paired with a server-side project similar to
+> [ASP.NET Web Application Starter Kit](https://github.com/kriasoft/AspNet-Server-Template).
**Source**: [https://github.com/kriasoft/react-seed](https://github.com/kriasoft/React-Seed)
-#### Runtime Components
+### Technology Stack
- * [React](https://facebook.github.io/react/) - A JavaScript library for building user interfaces, developed by Facebook
- * [React-Router](https://github.com/rackt/react-router) - A complete routing library for React
- * [Bootstrap](http://getbootstrap.com/) - CSS framework for developing responsive, mobile first interfaces
+**Runtime components**<br />
+[React](https://facebook.github.io/react/),
+[React-Router](https://github.com/rackt/react-router),
+[Bootstrap](http://getbootstrap.com/) (optional)
-#### Development Tools
-
- * [Gulp](http://gulpjs.com/) - JavaScript streaming build system and task automation
- * [Webpack](http://webpack.github.io/) - Compiles front-end source code into modules / bundles
- * [BrowserSync](http://www.browsersync.io/) - Lightweight HTTP server for development
- * [Karma](http://karma-runner.github.io/) - JavaScript unit-test runner (coming)
- * [Protractor](https://github.com/angular/protractor) - End-to-end test framework (coming)
+**Development tools**<br />
+[Gulp](http://gulpjs.com/) (build tool),
+[Webpack](http://webpack.github.io/) (bundler),
+[BrowserSync](http://www.browsersync.io/) (dev server),
+[Karma](http://karma-runner.github.io/) (coming),
+[Protractor](https://github.com/angular/protractor) (coming)
### Directory Layout
```
.
├── /build/ # The folder for compiled output
+├── /config/ # Configuration files for Webpack, Karma etc.
├── /docs/ # Documentation files
├── /node_modules/ # Node.js-based dev tools and utilities
├── /src/ # The source code of the application
-│ ├── /assets/
-│ ├── /data/
-│ ├── /common/
-│ ├── /components/
-│ ├── /images/
-│ ├── /layouts/
-│ ├── /pages/
-│ ├── /services/
-│ ├── /styles/
-│ ├── /404.html
-│ ├── /app.jsx
-│ └── /index.html
+│ ├── /assets/ # Static files which don't require pre-processing
+│ ├── /data/ # Data access layer and models
+│ ├── /common/ # Utility classes etc.
+│ ├── /components/ # React components. E.g. Navbar.jsx
+│ ├── /images/ # Graphics (.png, .jpg, .svg etc.)
+│ ├── /layouts/ # Layouts for web pages
+│ ├── /pages/ # Web pages. E.g. Profile.jsx (or .html, .jade etc.)
+│ ├── /services/ # Services and business logic
+│ ├── /styles/ # LESS style sheets (or SASS/SCSS, Stylus etc.)
+│ ├── /404.html # 'Page not found' page
+│ ├── /app.jsx # Entry point / bootstrap script
+│ └── /index.html # Home page of a single-page application (SPA)
├── /test/ # Unit, integration and load tests
│ ├── /e2e/ # End-to-end tests
│ └── /unit/ # Unit tests
-└── ...
+│── gulpfile.js # Configuration file for automated builds
+└── package.json # The list of 3rd party libraries and tools
```
### Getting Started
-To get started you can simply clone the repo and install the dependencies:
+Just clone or [fork](https://github.com/kriasoft/React-Seed/fork) the repo and start hacking:
+
+```shell
+$ git clone -o upstream https://github.com/kriasoft/React-Seed MyApp
+$ cd MyApp
+$ npm install -g gulp # Install Gulp task runner globally
+$ npm install # Install Node.js components listed in ./package.json
+```
+
+### How to Build
```shell
-> git clone -o base https://github.com/kriasoft/React-Seed MyApp
-> cd MyApp
-> npm install -g gulp # Install Gulp task runner globally
-> npm install # Install Node.js components listed in ./package.json
+$ gulp build # or, `gulp build --release`
```
-To compile the application and start a dev server run:
+By default, it builds in debug mode. If you need to build in release mode, add
+`--release` flag.
+
+
+### How to Run
```shell
-> gulp # or, `gulp --release`
+$ gulp # or, `gulp --release`
```
-To build the project, without starting a web server run:
+This will start a lightweight development server with LiveReload and
+synchronized browsing support across multiple devices and browsers.
+
+### How to Deploy
```shell
-> gulp build # or, `gulp build --release`
+$ gulp deploy # or, `gulp deploy --production`
```
-To deploy the application, run:
+You can deploy to different destinations by adding a corresponding flag.
+For example `--production` or `--staging` etc. See the 'deploy' task in
+`gulpfile.js`.
+
+### How to Update
+
+You can always fetch and merge the recent changes from this repo back into
+your own project:
```shell
-> gulp deploy # or, `gulp deploy --production`
+$ git checkout master
+$ git fetch upstream
+$ git merge upstream/master
+$ npm install
```
### Contributors
