Skip to content

william-woodhead/next-typescript-mui-starter

Repository files navigation

Simple Next.js Typescript Material-UI JSS Starter

The simplest possible Next.js Typescript Material-UI JSS React Boilerplate.

This repo is an attempt to make the simplest possible Next.js Typescript Material-UI React JSS Boilerplate.

Boilerplates can be a great for two things:

  1. Get started with your application code quickly since you don't have to scaffold your app.
  2. Learn how apps can be scaffolded, and learn how technologies can fit together.

This repository is more aimed at the second point.

It was born out of frustrations with complex boilerplates where you can't understand what is going on behind the scenes. Developers tend to want to know how things work under the hood. This repo offers a boiled-down example to be tweaked and hacked around with.

It tries to be as un-opinionated and simple as possible.

It borrows heavily from the documentation of Next.js, Material UI and JSS

These are the technologies it uses:

For the app

Build tools

Commands

Install
yarn install
Develop
yarn run dev

Open localhost:3000

Build for production
yarn run build
Run in production
yarn run start

Open localhost:3000

Platform

This repo is developed and tested on Mac OS with node v10.10.0 and npm v6.7.0

Diving into the code

The best place to start is in /pages/_app.tsx and /pages/_document.tsx. These are special files as specified by Next.js.

Contributing

Any issues, reports, feedback or bugs or pull requests are more than welcome.

However it is worth mentioning that the purpose of this repo is to create the simplest, most up-to-date, most robust universal async react redux boilerplate.

Therefore any pull request should aim to simplify, fix or update the current solution, not add new packages or complexity.

License

MIT License

Copyright (c) 2019 William Woodhead

Have a play around

Good luck with it! Please star or follow on twitter: @williamwoodhead