βš›οΈ πŸš€ A progressive static site generator for React.
Clone or download
Latest commit 99f036a Dec 17, 2018

README.md

React Static Logo

Travis CI Build Status David Dependancy Status npm package v npm package dm Join the community on Spectrum Github Stars Twitter Follow



You are viewing the docs for v6 of React Static. You can browse all historical versions via Github branches!

React Static

A progressive static-site generator for React.

React-Static is a fast, lightweight, and powerful framework for building static-progressive React applications and websites. It's been carefully designed to meet the highest standards of static-site performance, and user/developer experience.

Sponsored By GraphCMS

Features

  • βš›οΈ 100% React (and friends!)
  • πŸš€ Blazing fast builds and performance.
  • 🚚 Data Agnostic. Supply your site with data from anywhere, however you want.
  • βœ‚οΈ Automatic code and data splitting!
  • πŸ’₯ Instant page views via PRPL pattern.
  • β˜”οΈ Progressive Enchancement + Graceful Fallbacks
  • 🎯 SEO Friendly.
  • πŸ₯‡ React-first developer experience.
  • 😌 Painless project setup & migration.
  • πŸ’― Supports 100% of the React ecosystem. Including CSS-in-JS libraries, custom Query layers like GraphQL, and even Redux.
  • πŸ”₯ Hot Reloadable out-of-the-box. Edit React components & styles in real-time.
  • πŸ“² LAN accessible dev environment for testing on other devices like phones and tablets.

Articles, Videos & Tutorials

Sites Built with React-Static

Quick Start

  1. Install the CLI:
$ yarn global add react-static
# or
$ npm install -g react-static
  1. Create a new project:
$ react-static create
  1. Pick a template! See the full list of templates
  2. Navigate to your new project:
$ cd my-static-site
  1. Start the dev server and edit some code!
$ yarn start # or react-static start
  1. Test a production build
$ yarn stage # or react-static build --staging
$ yarn serve
  1. Build for production!
$ yarn build # or react-static build

Once you've installed and test driven, you may want to:

Plugins

Examples and Templates

React Static ships with a ton of examples to reference and each of them can even be used as a starting template when using react-static create!

See all Templates and Examples

Can't find an example? We invite you to write one! Simply copy the basic or blank templates and make the necessary changes. Then submit a PR including your new example directory and a new item in the list above. When merged, your example will automatically become a template in the CLI. How magical!

Documentation

Support, Community & Chat

Need some help? Have a quick question? Click here to sign up for the React-Tools spectrum community! We are constantly answering questions, discussing features and helping each other out!

Contributing, Issues & Bugs

We are always looking for people to help us grow react-static's capabilities and examples. If you have found a bug, or have a feature request let us know!

License

React Static uses the MIT license. For more information on this license, click here.