https://github.com/amalv/guestbook

A well-structured production ready Next.js project featuring a Guestbook app as an example with Typescript, Styled Components, Material UI, Github Actions pipeline, Eslint, Prettier, Cypress, Semantic Release and a 12-column based Grid
https://github.com/amalv/guestbook

cypress cypress-io github-actions grid-layout material-ui nextjs prettier semantic-release styled-components typescript

Last synced: 3 months ago
JSON representation

A well-structured production ready Next.js project featuring a Guestbook app as an example with Typescript, Styled Components, Material UI, Github Actions pipeline, Eslint, Prettier, Cypress, Semantic Release and a 12-column based Grid

• Host: GitHub
• URL: https://github.com/amalv/guestbook
• Owner: amalv
• Created: 2020-04-18T17:51:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T03:43:42.000Z (over 3 years ago)
• Last Synced: 2025-07-02T13:12:49.895Z (12 months ago)
• Topics: cypress, cypress-io, github-actions, grid-layout, material-ui, nextjs, prettier, semantic-release, styled-components, typescript
• Language: TypeScript
• Homepage: https://guestbook.amalv.now.sh/
• Size: 1.97 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# A well-structured production ready Next.js project featuring a Guestbook app as an example

![Staging](https://github.com/amalv/guestbook/workflows/Staging/badge.svg) ![Production](https://github.com/amalv/guestbook/workflows/Production/badge.svg)

## Features

Next.js project with a Guestbook example app which provides a lot of features out of the box. Folowing an overview of the included components and tools:

- **Next.js** - Minimalistic framework for server-rendered React applications.

- **ESLint** - The pluggable linting utility.

- **Styled Components** - Visual primitives for the component age.

- **Material UI** - React components for faster and easier web development.

- **Github Actions** - Complete pipeline for Continuous Integration and Continuous Delivery.

- **Prettier** - Opinionated code formatter.

- **Cypress** - End-to-end testing tool.

- **Semantic Release** - Fully automated version management which follows the Semantic Versioning specification.

- **Grid** - Responsive UI based on a 12-column grid layout.

## Setup

### Install dependencies

```sh

npm install

```

### Run the app in development mode

```sh

npm run dev

```

Then open [http://localhost:3000/](http://localhost:3000/) to see your app.