rssr-org / RSSR-Documentation

Document Of RSSR boilerplate

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


RSSR is a React Server Side Rendering biolerplate that helps you creat SSR React apps easier than any time.

Features

  • SSR (Server Side Rendering)
  • User authentication structure
  • SEO optimization utilities
  • SCSS Style Namespace
  • and more…

Installation

NOTE: Make sure that you have Node.js ^10.13.0 and npm ^6 installed.

// Clone the RSSR repository 
git clone https://github.com/rssr-org/RSSR.git <YOUR_PROJECT_NAME>

// Move to cloned RSSR app directory
cd <YOUR_PROJECT_NAME>

// Install the require npm packages
npm install

Usage tips

Remove Fake API

We connected the Fake-API to the RSSR so you can see how it actually works.

after clone see help.txt file in ~/FakeApi directory.

Run in development mode

npm run dev

Run in production mode

  1. Create /dist directory, that contains the builded of your RSSR app
npm run build
  1. Run the builded RSSR app
    NOTE: For running your RSSR app, you have two Predetermined ways.You can modify these latter by yourself.
npm run start

or,

npm run start-pm2

If you run your RSSR app with PM2, you can update your project after changes, with:

npm run up

Read more: Getting Started
Read everything about RSSR: Documentation

About

Document Of RSSR boilerplate