Skip to content

wearepush/push-starter

Repository files navigation

React Redux Styled Hot Universal

React boilerplate, used best practices and focus on performance

Build Status


Live Demo 👀

About

The starter boilerplate includes the following technologies:

Technology Description
Node 16.0.0 LTS Node
Redux Dev Tools Redux Dev Tools
React 17 JavaScript library for building user interfaces
React Router 6 React Router is a complete routing library for React
Babel Babel is a JavaScript compiler
Webpack 5 Module bundler
Universal Webpack Helps setting up universal Webpack build: the one that's working both on client and server
Redux Redux is a predictable state container for JavaScript apps
React Router Redux Simple bindings to keep react-router and redux in sync
ESLint The pluggable linting utility for JavaScript and JSX
Include-media Sass library for writing CSS media queries in an easy and maintainable way

Installation

rm -rf node_modules
npm install

Running Prod Server

npm start

Running Dev Server

npm run dev

Running Tests

npm run test

Deployment on Heroku

To get this project to work on Heroku, you need to:

  1. Add heroku heroku git:remote -a heroku-app-name
  2. heroku config:set NODE_ENV=production
  3. heroku config:set NPM_CONFIG_PRODUCTION=false
  4. heroku config:set SSL=true
  5. heroku config:set GOOGLE_ANALITICS_ID=UA-xxxxxxxxx-x (optional)

Docker

Run container

docker-compose up -d

Build an image

docker build -t wearepush/push-starter .

Contributing

We are more than happy to accept external contributions to the project in the form of feedback, bug reports and even better - pull requests :) If you would like to submit a pull request, please make an effort to follow the guide in CONTRIBUTING.md.