rtivital / react-pages-boilerplate

Deliver react + react-router application to gh-pages

React pages boilerplate

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

Technologies

• Typescript
• Mantine
• Webpack@5 as module bundler
• Eslint for linting
• Prettier for automated code formatting
• Jest with Enzyme for testing

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.