React-Material-Site

A VERY opinionated website framework built with react and material design which is highly configurable and high level components in order to speed development of new projects. You won't win any awards for a site built with this, but you might just be able to have that functionality you needed yesterday.

Some tech used

• Material Components Web - The foundation for all UI elements is built with new and shiny (and still Alpha) material components for web published by Google.
• RMWC - The wrapper for MDC-web made by James Friedman, which adds some extra functionality and a very clean API for using components in a react app.
• Create React App - The amazing create-react-app by Facebook that manages build and test running without 100000 dependencies you have you manage yourself.
• json-google-docs - Converts a google docs into structured JSON and allows you to use this content within your site, functions as a CMS editor for the site.
• form-google-sheets - Allows you to post data to an endpoint that populates a google sheet so you can deploy a basic website with a contact form with no server.

Other cool features

• Configuration based routing system
• Support for multiple languages
• SSO Authentication with Auth0

Requirements

• Node >= 6.0.0
• Yarn >= 0.25.0 or NPM >= 6.0.0
• Should work on Linux, OSX, Windows

Optional Services

• Auth0 - Provides authentication handling and SSO
• Netlify - Provides static hosting, SSL, and continuous deployment
• Sentry - Provides error tracking and logging
• Crisp - Provides chat widget for in-app support
• Google Analytics - Provides site analytics
• Google Docs - Provides dynamic site content
• Google Sheets - Provides basic data store for form submissions

Installation

# First create a site with create-react-app
yarn create react-app amazing-site
cd amazing-site

# Add react-material-site to app with yarn
yarn add react-material-site

# OR add react-material-site to app with yarn
npm install react-material-site --save

# TODO Figure out installer script, or calling API

Development

yarn start

Testing

yarn test

Contributors

Colin Gagnon