https://github.com/rtivital/react-pages-boilerplate

Deliver react + react-router application to gh-pages
https://github.com/rtivital/react-pages-boilerplate

babel boilerplate css-modules enzyme eslint gh-pages hot-reload jest react react-pages-boilerplate react-router webpack

Last synced: 22 days ago
JSON representation

Deliver react + react-router application to gh-pages

• Host: GitHub
• URL: https://github.com/rtivital/react-pages-boilerplate
• Owner: rtivital
• License: mit
• Created: 2016-08-14T13:02:01.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-08T01:16:36.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T12:37:41.952Z (7 months ago)
• Topics: babel, boilerplate, css-modules, enzyme, eslint, gh-pages, hot-reload, jest, react, react-pages-boilerplate, react-router, webpack
• Language: JavaScript
• Homepage:
• Size: 10.4 MB
• Stars: 149
• Watchers: 9
• Forks: 22
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React pages boilerplate

![Cover](cover.png)

This boilerplate introduces a simple way for developing serverless React applications, which are perfect for serving from [Github Pages](https://pages.github.com/).

## Technologies

- Typescript

- [Mantine](https://mantine.dev/)

- [Webpack@5](https://webpack.js.org/) as module bundler

- [Eslint](http://eslint.org/) for linting

- [Prettier](https://prettier.io/) for automated code formatting

- [Jest](https://facebook.github.io/jest/) with [Enzyme](http://airbnb.io/enzyme/) for testing

## Getting started

- Clone `git clone https://github.com/rtivital/react-pages-boilerplate` or [download](https://github.com/rtivital/react-pages-boilerplate/archive/master.zip) 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](https://github.com/creationix/nvm).

- Install dependencies: `yarn`

- Run the project: `npm start`

## Settings

[settings.js](./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](https://github.com/rtivital/react-pages-boilerplate/releases/) to get information about new cool features added to the project.