(not maintained) React static site generator framework for Node.js
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
defaults
lib
.babelrc
.eslintrc
.gitignore
LICENSE
README.md
index.js
package.json

README.md

react-static

(NO LONGER ON NPM & NOT MAINTAINED) React static site generator framework for Node.js.

What is this?

This project exists as a static site generator that utilizes React components for markup but, unlike other static site generators, also generates the client-side React JavaScript to allow the linking between pages to be incredibly fast out of the box. This means you'll also be able to have any other fancy client-side-oriented React bundled, as well.

Under the hood, this tool builds off of React, react-router and nodejs to build static markup and JavaScript.

Installation

If for some reason you'd like to install this:

  1. clone this repository
  2. run $ npm install
  3. run $ npm link
  4. from your projects folder, run $ npm link react-static
  5. use the tool as specified below

Usage

Create a new react-static project:

$ react-static new portfolio/
Installing react-static in to `portfolio/`
=> Successfully installed in to `portfolio/`
=> Run the following to complete setup:

    $ cd portfolio/ && npm install

=> Once setup is complete, to run the development server:

    $ react-static serve

Change directory in to portfolio/ and install dependencies:

$ cd portfolio/ && npm install

This might take a minute. Once your dependencies are installed, start the local dev bundling and watching:

$ react-static serve

> @ build /Users/rpearce/Desktop/portfolio
> npm run lint && babel-node --optional es7.asyncFunctions --stage 0 "index.js"

> @ lint /Users/rpearce/Desktop/portfolio
> eslint src

=> Building static assets...
=> Static assets written to _site/
=> A development server is running at http://localhost:4000

Navigate to http://localhost:4000 and see the dummy components in action.

From this point on, all you need to do with regards to this core functionality is make changes to your app, and react-static serve will re-bundle and re-serve everything automatically.

NOTE: Do not edit anything in the \_site/ folder. This is regularly removed and recreated.

Creating a Component

Inside of the src/components/ components directory is where your components live, and you are free to structure them in any way you see fit, but if you change the location of routes.js, you're going to have problems.

Create a new file, e.g., src/components/About.react.js, and place this content inside of it:

import React from 'react';

const About = () =>
  <main role="main">
    <header>
      <h1>About</h1>
    </header>
  </main>

About.meta = {
  title: 'About',
  description: 'This is the about us page'
};

export default About;

If you're wondering where class and extend are, don't worry! This is a stateless functional component, as included in the [React 0.14 release notes](NEED LINK), that also sets a few static properties: title and description that are used in src/components/Root.react.js to provide metadata for your page (extend this as you wish).

Next go to your src/components/routes.js file and import your About component:

import About from './About.react';

and add the route information to the routes object:

const routes = {
  // other routes

  About: {
    path: 'desired/path/to/about.html',
    component: About
  }
}

Once you've done this, if you haven't already run

$ react-static serve

go ahead and do that. Happy coding!

Contribute

  1. Check out the issues
  2. Fork this repository
  3. Clone your fork
  4. Check out a feature branch ($ git checkout -b my-feature)
  5. Make your changes and push your branch to your GitHub repo
  6. Create a pull request from your branch to this repo's master
  7. When all is merged, pull down the upstream changes to your master