Awesome Open Source
Awesome Open Source

React pages boilerplate

Cover This boilerplate introduces a simple way for developing serverless React applications, which are perfect for serving from Github Pages.

Technologies

Getting started

  • Clone git clone https://github.com/rtivital/react-pages-boilerplate or download this repository.
  • (Optional) Run nvm use. This will ensure that you are running the supported version of Node.js. You can nvm installation instructions here.
  • Install dependencies: yarn
  • Run the project: npm start

Settings

settings.js file includes all important settings that should be used to setup deployments to gh-pages:

  • title – Base application title
  • cname – Adds CNAME file that allows to use custom domain names with gh-pages
  • repoPath – username.github.io/repoPath for react router to recognize gh-pages paths
  • prerenderRoutes – routes that should be prerendered before deploy

npm scripts

  • npm start – starts development server with webpack-dev-server
  • npm test – runs tests with Jest
  • npm run build – builds project to production
  • npm run deploy – builds and deploys project to Github pages
  • npm run lint – lints JavaScript files
  • npm run prettier – format js and jsx files with prettier

Changelog

See releases section to get information about new cool features added to the project.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (70,927
react (5,567
webpack (1,171
boilerplate (648
babel (358
jest (291
eslint (263
react-router (215
css-modules (80
hot-reload (77
enzyme (46
gh-pages (35