https://github.com/csprance/next-smrt

Next.js, Styled-Components, Material UI, Redux, Typescript Boilerplate (Docker Ready)
https://github.com/csprance/next-smrt

Last synced: about 2 months ago
JSON representation

Next.js, Styled-Components, Material UI, Redux, Typescript Boilerplate (Docker Ready)

• Host: GitHub
• URL: https://github.com/csprance/next-smrt
• Owner: csprance
• License: unlicense
• Created: 2018-07-27T07:52:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T16:29:14.000Z (over 1 year ago)
• Last Synced: 2024-06-25T03:35:51.309Z (3 months ago)
• Language: TypeScript
• Homepage: https://next-smrt.csprance.com
• Size: 3.15 MB
• Stars: 55
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-typescript - next-smrt
• awesome-nextjs - csprance/next-smrt - A minimal boilerplate with redux, styled-components, material-ui and typescript with a custom express server. (Boilerplates)

README

        
![Example To Do App](public/static/site-image.png)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

# Next-SMRT

> Next.js, Styled Components, Material-UI, Zustand (Redux replacement), Typescript

A lot of the next.js examples have some of those features but not all together. So I decided to roll them all into one boilerplate.

I use it to kickstart everything I do now. Works great in production and comes with docker batteries included.

## Example TODO List App

![Example To Do App](https://csprance.com/shots/2019-07-21_642df2a7-ae0d-4f07-80b5-b05c7cbd0555.png)

## Features

### Uses

 - [NextJS](https://github.com/zeit/next.js)

 - [React](https://github.com/facebook/react)

 - [Typescript](https://github.com/Microsoft/TypeScript)

 - [Zustand](https://github.com/pmndrs/zustand)

 - [Immer](https://github.com/reduxjs/redux-toolkit)

 - [Jest](https://github.com/facebook/jest)

 

### Using cdn

 - material-icons font

 - roboto-font

## Installation

```sh

git clone https://github.com/csprance/next-smrt.git

```

or just click the `Use This Template` button above.

## Setup

set SEO variables

> src/constants/env.ts

```typescript

// for meta tag 

export const SITE_NAME = ''

export const SITE_TITLE = ''

export const SITE_DESCRIPTION = ''

export const SITE_IMAGE = ''

```

---

## Environment Install Instructions

### Development

#### Installation

```

yarn

yarn dev

```

#### Test

```

yarn test # test

yarn test:watch

yarn test:coverage # report coverage

```

### Production

```

yarn

yarn build # create .next directory

yarn start # start server

```

# Docker

> Assumes [traefik](https://traefik.io) is running

* run `docker-compose up -d --build`

* Visit `http://next-smrt.localhost` 

Check out the other docker-compose files for more uses and the `Dockerfile` for the image 

that will be built to run the app

 

## License

UNLICENSE