βš›οΈ πŸš€ A progressive static site generator for React.
Clone or download
Latest commit 5a62d06 Jan 21, 2019

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.

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 Enhancement + 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

Or use npx to create an app without global installing the CLI

npx react-static create --name=my-app
  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:

Documentation

Plugins

For a list of supported plugins, view the Plugin documentation.

Templates and Guides

React Static ships with a few basic templates to you get you started quickly with react-static create, then provides in-depth guides for further enhancement. You can check them out here!

Can't find an guide? You should write one! Here's how to get started.

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.