An open API service indexing awesome lists of open source software.

https://github.com/paralect/react-material-ui-koa-starter


https://github.com/paralect/react-material-ui-koa-starter

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# React Material-UI Koa starter

[![Stack](https://raw.githubusercontent.com/paralect/stack/master/stack-component-template/stack.png)](https://github.com/paralect/stack)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)
[![Known Vulnerabilities](https://snyk.io/test/github/paralect/react-material-ui-koa-starter/badge.svg)](https://snyk.io/test/github/paralect/react-material-ui-koa-starter)
[![All Contributors](https://img.shields.io/github/all-contributors/paralect/react-material-ui-koa-starter)](#contributors)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![David Dependency Status](https://david-dm.org/paralect/react-material-ui-koa-starter.svg)](https://david-dm.org/paralect/react-material-ui-koa-starter)

[![Watch on GitHub](https://img.shields.io/github/watchers/paralect/react-material-ui-koa-starter.svg?style=social&label=Watch)](https://github.com/paralect/react-material-ui-koa-starter/watchers)
[![Star on GitHub](https://img.shields.io/github/stars/paralect/react-material-ui-koa-starter.svg?style=social&label=Stars)](https://github.com/paralect/react-material-ui-koa-starter/stargazers)
[![Follow](https://img.shields.io/twitter/follow/paralect.svg?style=social&label=Follow)](https://twitter.com/paralect)
[![Tweet](https://img.shields.io/twitter/url/https/github.com/paralect/react-material-ui-koa-starter.svg?style=social)](https://twitter.com/intent/tweet?text=I%27m%20using%20Stack%20components%20to%20build%20my%20next%20product%20🚀.%20Check%20it%20out:%20https://github.com/paralect/stack)

React Material-UI Koa starter is what we think an ideal starting point for React progressive web-applications (PWA) with the power of Material design components, offline-mode, SSR etc. It is based on the following primary technologies:

- [react](https://reactjs.org/)
- [react-router](https://reactrouter.com/web)
- [react-query](https://react-query.tanstack.com/)
- [material-ui](https://material-ui.com/)
- [razzle](https://razzlejs.org/)

Universal JavaScript applications are tough to setup. Either you buy into a framework like [Next.js](https://github.com/zeit/next.js) or [react-server](https://github.com/redfin/react-server), fork a boilerplate, or set things up yourself. Aiming to fill this void, we use Razzle as a tool that abstracts all complex configuration needed for SSR into a single dependency - giving you the awesome developer experience of [create-react-app](https://github.com/facebookincubator/create-react-app), but then leaving the rest of your app's architectural decisions about frameworks, routing, and data fetching up to you.

## Quick Start

Below is a list of commands you will probably find useful.

### `npm start` or `yarn start`

Runs the project in development mode.
You can view your application at `http://localhost:3000`
Your console should look like this:

Razzle Development Mode

The page will reload if you make edits.

### `npm run build` or `yarn build`

Builds the app for production to the build folder.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

### `npm run start:prod` or `yarn start:prod`

Runs the compiled app in production.

You can again view your application at `http://localhost:3000`

### `npm test` or `yarn test`

Runs the test watcher (Jest) in an interactive mode.
By default, runs tests related to files changed since the last commit.

### `npm start -- --inspect` or `yarn start -- --inspect`

To debug the node server, you can use `razzle start --inspect`. This will start the node server and enable the inspector agent. For more information, see [this](https://nodejs.org/en/docs/inspector/).

### `npm start -- --inspect-brk` or `yarn start -- --inspect-brk`

To debug the node server, you can use `razzle start --inspect-brk`. This will start the node server, enable the inspector agent and Break before user code starts. For more information, see [this](https://nodejs.org/en/docs/inspector/).

### `rs`

If your application is running, and you need to manually restart your server, you do not need to completely kill and rebundle your application. Instead you can just type `rs` and press enter in terminal.

## Razzle Hot Restart

#### Read [Razzle documentation](https://razzlejs.org/) for more info

---

MIT License

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):



Ihar

🤔 👀

Mike Gagarin

💻 📖 🤔

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!