Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/p-jackson/codeview
https://github.com/p-jackson/codeview
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/p-jackson/codeview
- Owner: p-jackson
- Created: 2015-11-07T10:49:30.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-11-08T11:19:34.000Z (about 9 years ago)
- Last Synced: 2023-08-06T02:53:37.403Z (over 1 year ago)
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## React Starter Kit — "isomorphic" web app boilerplate
[](https://salt.bountysource.com/teams/react-starter-kit)
> [React Starter Kit](http://www.reactstarterkit.com) is an opinionated
> boilerplate for web development built on top of Facebook's
> [React](https://facebook.github.io/react/) library,
> [Node.js](https://nodejs.org/) / [Express](http://expressjs.com/) server
> and [Flux](http://facebook.github.io/flux/) architecture. Containing
> modern web development tools such as [Webpack](http://webpack.github.io/),
> [Babel](http://babeljs.io/) and [BrowserSync](http://www.browsersync.io/).
> Helping you to stay productive following the best practices. A solid starting
> point for both professionals and newcomers to the industry.
Demo: http://demo.reactstarterkit.com |
Join [#react-starter-kit](https://gitter.im/kriasoft/react-starter-kit) chatroom on Gitter to stay up to date.
### Documentation
* **General**
- [React Style Guide](./docs/react-style-guide.md)
- [How to configure text editors and IDEs](./docs/how-to-configure-text-editors.md)
* **Questions**
- [Which module bundler should I use?](https://github.com/kriasoft/react-starter-kit/issues/3)
- [Which Flux implementation should I use?](https://github.com/kriasoft/react-starter-kit/issues/22)
* **Recipes**
- [How to Implement Routing and Navigation](./docs/recipes/how-to-implement-routing.md)
- [How to Integrate Disqus](./docs/recipes/how-to-integrate-disqus.md)
### Directory Layout
```
.
├── /build/ # The folder for compiled output
├── /docs/ # Documentation files for the project
├── /node_modules/ # 3rd-party libraries and utilities
├── /src/ # The source code of the application
│ ├── /actions/ # Action creators that allow to trigger a dispatch to stores
│ ├── /api/ # REST API / Relay endpoints
│ ├── /components/ # React components
│ ├── /constants/ # Constants (action types etc.)
│ ├── /content/ # Static content (plain HTML or Markdown, Jade, you name it)
│ ├── /core/ # Core components (Flux dispatcher, base classes, utilities)
│ ├── /decorators/ # Higher-order React components
│ ├── /public/ # Static files which are copied into the /build/public folder
│ ├── /stores/ # Stores contain the application state and logic
│ ├── /utils/ # Utility classes and functions
│ ├── /app.js # Client-side startup script
│ ├── /config.js # Global application settings
│ ├── /routes.js # Universal (isomorphic) application routes
│ └── /server.js # Server-side startup script
├── /tools/ # Build automation scripts and utilities
│ ├── /lib/ # Library for utility snippets
│ ├── /build.js # Builds the project from source to output (build) folder
│ ├── /bundle.js # Bundles the web resources into package(s) through Webpack
│ ├── /clean.js # Cleans up the output (build) folder
│ ├── /webpack.config.js # Configurations for client-side and server-side bundles
│ ├── /copy.js # Copies static files to output (build) folder
│ ├── /deploy.js # Deploys your web application
│ ├── /serve.js # Launches the Node.js/Express web server
│ └── /start.js # Launches the development web server with "live reload"
│── package.json # The list of 3rd party libraries and utilities
└── preprocessor.js # ES6 transpiler settings for Jest
```
### Getting Started
Just clone the repo and start hacking:
```shell
$ git clone -o react-starter-kit -b master --single-branch \
https://github.com/kriasoft/react-starter-kit.git MyApp
$ cd MyApp
$ npm install # Install Node.js components listed in ./package.json
$ npm start # Compile and launch
```
### How to Build
```shell
$ npm run build # or, `npm run build -- --release`
```
By default, it builds in *debug* mode. If you need to build in release
mode, just add a `-- --release` flag. This will optimize the output bundle for
production.
### How to Run
```shell
$ npm start # or, `npm start -- --release`
```
This will start a light-weight development server with "live reload" and
synchronized browsing across multiple devices and browsers.
### How to Deploy
```shell
$ npm run deploy # or, `npm run deploy -- --production`
```
For more information see `tools/deploy.js`.
### How to Update
You can always fetch and merge recent changes from this repo back into
your own project:
```shell
$ git checkout master
$ git fetch react-starter-kit
$ git merge react-starter-kit/master
$ npm install
```
### How to Test
Run unit tests powered by [Jest](https://facebook.github.io/jest/) with the following
[npm](https://www.npmjs.org/doc/misc/npm-scripts.html) command:
```shell
$ npm test
```
Test any javascript module by creating a `__tests__/` directory where
the file is. Append `-test.js` to the filename and [Jest](https://facebook.github.io/jest/) will do the rest.
### Our Sponsors
[](https://rollbar.com/?utm_source=reactstartkit(github)&utm_medium=link&utm_campaign=reactstartkit(github))
[](http://www.makersacademy.com/?utm_source=ReactStarterKit&utm_medium=link&utm_campaign=ReactStarterKitGithub)
### Related Projects
* [React Static Boilerplate](https://github.com/koistya/react-static-boilerplate) — Generates static websites from React components
* [Babel Starter Kit](https://github.com/kriasoft/babel-starter-kit) — Boilerplate for authoring JavaScript/React.js libraries
* [React Decorators](https://github.com/kriasoft/react-decorators) — A collection of higher-order React components
### Learn More
* [Getting Started with React.js](http://facebook.github.io/react/)
* [Getting Started with GraphQL and Relay](https://quip.com/oLxzA1gTsJsE)
* [React.js Questions on StackOverflow](http://stackoverflow.com/questions/tagged/reactjs)
* [React.js Discussion Board](https://discuss.reactjs.org/)
* [Flux Architecture for Building User Interfaces](http://facebook.github.io/flux/)
* [Jest - Painless Unit Testing](http://facebook.github.io/jest/)
* [Flow - A static type checker for JavaScript](http://flowtype.org/)
* [The Future of React](https://github.com/reactjs/react-future)
* [Learn ES6](https://babeljs.io/docs/learn-es6/), [ES6 Features](https://github.com/lukehoban/es6features#readme)
### Support
* [#react-starter-kit](https://gitter.im/kriasoft/react-starter-kit) on Gitter — Feedback, feature requests, Q&A
* [@koistya](https://www.codementor.io/koistya) on Codementor — Mentorship, code reviews
* [email protected] — Customization requests, help with GraphQL/Relay back-ends etc.
### License
Copyright © 2014-2015 Kriasoft, LLC. This source code is licensed under the MIT
license found in the [LICENSE.txt](https://github.com/kriasoft/react-starter-kit/blob/master/LICENSE.txt)
file. The documentation to the project is licensed under the
[CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/) license.
---
Made with ♥ by Konstantin Tarkus ([@koistya](https://twitter.com/koistya)) and [contributors](https://github.com/kriasoft/react-starter-kit/graphs/contributors)