Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wayofdev/next-starter-tpl

🤖 This is a microservices-ready template for building Next.js applications, used by Wayofdev. It comes bundled with Turbo and is managed as a monorepo using PNPM
https://github.com/wayofdev/next-starter-tpl

boilerplate docker docker-compose jest microservice next-js next-js-app next-js-starter-template next-js-template next-starter-template nextjs nextjs-boilerplate nextjs-docker nextjs-template pnpm pnpm-workspace turborepo typescript vercel

Last synced: about 15 hours ago
JSON representation

🤖 This is a microservices-ready template for building Next.js applications, used by Wayofdev. It comes bundled with Turbo and is managed as a monorepo using PNPM

Host: GitHub
URL: https://github.com/wayofdev/next-starter-tpl
Owner: wayofdev
License: mit
Created: 2022-12-07T13:04:57.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-04-11T17:48:11.000Z (6 months ago)
Last Synced: 2024-04-11T22:22:09.028Z (6 months ago)
Topics: boilerplate, docker, docker-compose, jest, microservice, next-js, next-js-app, next-js-starter-template, next-js-template, next-starter-template, nextjs, nextjs-boilerplate, nextjs-docker, nextjs-template, pnpm, pnpm-workspace, turborepo, typescript, vercel
Language: TypeScript
Homepage: https://next-starter-tpl-docs.wayof.dev
Size: 4.21 MB
Stars: 57
Watchers: 1
Forks: 8
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


















View Documentation / Demo































# NextJS Starter Template

## 📄 About

This repository contains a [monorepo](https://turbo.build/repo/docs/handbook/what-is-a-monorepo) boilerplate written in [Next.js](https://nextjs.org/), managed by the [pnpm](https://pnpm.io) package manager.

You can use it with the backend template, written in Laravel — [laravel-starter-tpl](https://github.com/wayofdev/laravel-starter-tpl).

### → Purpose

- Establish a clear structure and present a lifecycle perspective (developer experience, continuous integration/continuous deployment, and deployments);

- Demonstrate how to create and consume shared packages, locales, assets, and API types;

- Provide a fully configured repository with integrated tools and configs, such as tsconfig, eslint, jest, cypress, tailwind, changelogs, versioning, codecov, codeclimate, sentry, and others;

- Clarify advantages of using a monorepo, such as team cohesion, consistency, duplication, refactorings, and atomic commits.

### → Utilities and Features

This repository has some additional tools already setup for you:

- Supporting [NextJS 13.1.1+](https://nextjs.org/blog/next-13)

- [TypeScript](https://www.typescriptlang.org/) support for static type checking

- Strict Mode for TypeScript and React 18

- [ESLint](https://eslint.org/) for code linting and configured presets: NextJS Recommended, NextJS Core Web Vitals and [Airbnb Style Guide](https://www.npmjs.com/package/eslint-config-airbnb)

- Code formatting with [Prettier](https://prettier.io/)

- Integrated with [Tailwind CSS](https://tailwindcss.com/)

- [PostCSS](https://postcss.org/) for processing Tailwind CSS and [CSSNANO](https://cssnano.co/) for CSS optimization on production systems

- Support for [HeroIcons](https://heroicons.com) out of the box

- [Husky](https://typicode.github.io/husky/#/) for modern native git hooks

- [Lint-staged](https://github.com/okonet/lint-staged) for running linters on Git staged files

- [GitHub Actions](https://github.com/features/actions) support out of the box

- SEO metadata, JSON-LD and Open Graph tags with [Next SEO](https://github.com/garmeeh/next-seo)

- Sitemap support using [next-sitemap](https://www.npmjs.com/package/next-sitemap)

- [Bundler Analyzer](https://www.npmjs.com/package/@next/bundle-analyzer) — Visualize size of webpack output files with an interactive zoomable treemap

- Optimized [Lighthouse](https://web.dev/performance-scoring/) performance score

- End-2-end testing with [cypress](https://www.cypress.io/) and [JestJS](https://jestjs.io/) support for writing unit tests

- Package auto-update in all workspace projects using [npm-check-updates](https://www.npmjs.com/package/npm-check-updates)

- Keep package.json sorted using [sort-package-json](https://www.npmjs.com/package/sort-package-json)

- Client and server side [error reporting](https://sentry.io/) supported by [@sentry/nextjs](https://www.npmjs.com/package/@sentry/nextjs)




🙏 If you find this repository useful, please consider giving it a ⭐️. Thank you!




## 🤔 What's inside?

[![Open in Gitpod](https://img.shields.io/badge/Open%20In-Gitpod.io-%231966D2?style=for-the-badge&logo=gitpod)](https://gitpod.io/#https://github.com/wayofdev/next-starter-tpl)

This turborepo uses [pnpm](https://pnpm.io) as a package manager. It includes the following packages/apps:

### → Structure

```bash

.

├── apps

│   ├── web                  # Next.js app - i18n, SSR, API, Jest, Cypress

│   └── docs                 # Nextra app

└── packages

    ├── common-i18n          # Locales...

    ├── facebook-pixel       # Facebook Pixel tracking functionality

    ├── google-tag-manager   # Google Tag Manager functionality

    └── ui                   # React stub components

```

### → Apps

| Application | URL                                                       | Description                                                  |

| ----------- | --------------------------------------------------------- | ------------------------------------------------------------ |

| `docs`      | **[Demo](https://next-starter-tpl-docs.vercel.app/)**     | [Nextra](https://nextra.site/) documentation template generated from [Nextra: Docs Starter Kit](https://vercel.com/templates/next.js/documentation-starter-kit) |

| `web`       | **[Demo](https://next-starter-tpl-web.vercel.app/)**      | [Next.js](https://nextjs.org/) app with TailwindCSS, Facebook Pixel and Google Tag Manager tracking, and Sentry support |

| `storybook` | **[Demo](https://next-starter-tpl-storybook.vercel.app)** | [Storybook](https://storybook.js.org) — UI component explorer for React components |

> **Note:** Apps should not depend on apps, they can depend on packages

### → Packages

| Package              | Docs                                                         | Description                           |

| -------------------- | ------------------------------------------------------------ | ------------------------------------- |

| `common-i18n`        | [README.md](https://github.com/wayofdev/next-starter-tpl/blob/master/packages/common-i18n/README.md) | Locales for multi-language support    |

| `facebook-pixel`     | [README.md](https://github.com/wayofdev/next-starter-tpl/blob/master/packages/facebook-pixel/README.md) | Facebook Pixel tracking functionality |

| `google-tag-manager` | [README.md](https://github.com/wayofdev/next-starter-tpl/blob/master/packages/google-tag-manager/README.md) | Google Tag Manager functionality      |

| `ui`                 | [README.md](https://github.com/wayofdev/next-starter-tpl/blob/master/packages/ui/README.md) | Shared react stub components          |

> **Note:** Apps can depend on packages, packages can depend on each others




## 🚩 Requirements

To use this repository, you need to meet the following requirements:

- **macOS** Monterey+ or **Linux**

- **Docker** 20.10 or newer

  - [How To Install and Use Docker on Ubuntu 22.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04)

- Installed **dnsmasq** service, running in the system. You can use [ansible-role-dnsmasq](https://github.com/wayofdev/ansible-role-dnsmasq) to install and configure this service.

- **Cloned, configured and running** [docker-shared-services](https://github.com/wayofdev/docker-shared-services) to support system-wide DNS, routing, and TLS support via Traefik.




## 💿 Installation and Usage

> Warning: You should configure, set up, and run the [docker-shared-services](https://github.com/wayofdev/docker-shared-services) repository to ensure system-wide TLS and DNS support.

**[Follow getting-started guide in documentation](https://next-starter-tpl-docs.wayof.dev/guide/getting-started)** 🔗




## 🤝 License

[![Licence](https://img.shields.io/github/license/wayofdev/next-starter-tpl?style=for-the-badge&color=blue)](./LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwayofdev%2Fnext-starter-tpl.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwayofdev%2Fnext-starter-tpl?ref=badge_large)




## 🧱 Credits and Useful Resources

This repository is based on the [nextjs-monorepo-example](https://github.com/belgattitude/nextjs-monorepo-example) template from [belgattitude](https://github.com/belgattitude).

- Check his benchmark on package managers — [belgattitude/compare-package-managers](https://github.com/belgattitude/compare-package-managers)

Learn more about the power of **Turborepo**:

- [What is Monorepo?](https://turbo.build/repo/docs/handbook/what-is-a-monorepo)

- [Pipelines](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)

- [Caching](https://turbo.build/repo/docs/core-concepts/caching)

- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)

- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)

- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)

- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

Here are some other monorepo templates you may find useful:

- [waldronmatt/pnpm-turborepo-auto-boilerplate](https://github.com/waldronmatt/pnpm-turborepo-auto-boilerplate) — a monorepo boilerplate using pnpm, turborepo, and auto.

- [mkosir/turborepo-boilerplate](https://github.com/mkosir/turborepo-boilerplate) — frontend turborepo boilerplate

- [vercel/turbo](https://github.com/vercel/turbo/tree/main/examples) — turborepo examples from Vercel

- [nextauthjs/next-auth](https://github.com/nextauthjs/next-auth) — Authentication package, built as monorepo; real life example

Other projects:

- [Lots of the latest examples](https://github.com/vercel/next.js/tree/canary/examples) for NextJS from Vercel




## 🙆🏼‍♂️ Author Information

This repository was created in **2022** by [lotyp / wayofdev](https://github.com/wayofdev).




## 🙌 Want to Contribute?

Thank you for considering contributing to the wayofdev community!

We are open to all kinds of contributions. If you want to:

- 🤔 Suggest a feature

- 🐛 Report an issue

- 📖 Improve documentation

- 👨‍💻 Contribute to the code

You are more than welcome. Before contributing, kindly check our [guidelines](https://next-starter-tpl-docs.wayof.dev/contribution).




## 🫡 Contributors





  






## 🤑 Sponsors

  

    

      

        

          


        
Reproto



        _{🎖️ Financial Support}

      

      

        

          


        VarsityBase



        _{🎖️ Financial Support}

      

      

        

          


        Vercel



        _{☁️ Infrastructure Support}

      

      

        

          


        Sentry



        _{☁️ Infrastructure Support}

      

			

        

          


        ZenHub



        _{☁️ Infrastructure Support}