Skip to content

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

License

Notifications You must be signed in to change notification settings

natterstefan/nextjs-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

39 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

nextjs-template

Node CI GitHub issues GitHub stars GitHub license nextjs

natterstefan/nextjs-template

Ready to go template repository for your next Next.js application! πŸš€

Features

Requirements

Following tools are required:

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:

Deploy with 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

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.