natterstefan/nextjs-template

A practical starter template for Nextjs, which has Tailwind, Cypress, Docker, Storybook, Jest, ESLint, Prettier, and more built-in. 🚀

nextjs-template

Ready to go template repository for your next Next.js application! 🚀

Features

• ⭐️ Next.js@10.x
• ⭐️ Tailwind@2.x
• ⭐️ Jest
• ⭐️ Storybook
• ⭐️ ESLint and Prettier
• ⭐️ Docker
• ⭐️ i18n
• ⭐️ Cypress
• ⭐️ One-Click deployment to Vercel

Requirements

Following tools are required:

• Node.js
• Yarn
• Docker
• Java
• Optimized for Visual Studio Code

For easy version management of the requirements above, we recommend using asdf. It will automatically use the nailed versions (see tools-version). For Docker and Java we recommend the latest available versions.

Installation & Setup

yarn

Once the task is completed you can start the app with yarn dev.

Start

# development mode
yarn dev

# production mode
yarn build
yarn start

Probe Status /api/probe-status

The server comes with a Probe Status HTTP endpoint to test if app is running.

Version /api/version

The server comes with a Version HTTP endpoint to see which version is running.

Development

Tests & Code Style

yarn test
yarn lint

Deployment

Deploy your own

Deploy nextjs-template using Vercel:

Docker

nextjs-template also provides a Docker Image (see docker) and docker-compose setup.

Build Docker Image

./gradlew buildDockerImage

Run Docker Image

./gradlew runDockerBuild

Or when you want to run it in the background:

docker-compose --env-file ./.env.local up -d

References

• based on https://github.com/vercel/next.js/tree/master/examples/with-tailwindcss

License

MIT

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Stefan Natter 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!

---

Based on the https://github.com/natterstefan/nextjs-template template.