Skip to content

vbetsch/template-next

Repository files navigation

Next.js Full-Stack Starter Template

Checks Tests Build

⚡ Modern Next.js Template: Full-stack architecture, shared TS/Lint/Jest configs, Dependabot configuration and automated CI.

🚀 Getting Started

The recommended Node version is lts/krypton -> v24.14.1.

This repository is pre-configured. To start a new project:

  1. Clone this repository.
  2. Configure your environment (environment files, configurations files)
  3. Run npm install command.
  4. Complete the project :
  • Routes and endpoints are in app
  • Backend is in api
  • UI logic is in ui
  • Styles are in app
  • Medias files are in public
  • Communication between projects is in lib
  • Don't forget to update the tests !

🧪 Running Tests

Run tests in default mode

npm test

Run tests with coverage

npm run test:cov

🧹 Linting & Formatting

Run linter in default mode

npm run lint

Run linter in strict mode

npm run lint:strict

Format the code

npm run format

🏗️ Building the Project

Build application

npm run build

Check the build

npm run start:prod

🚥 Development Workflow

Validate your setup by running the following commands in order:

npm clean-install                       # Update dependencies
npm run start:dev                       # Check development execution
npm run format                          # Format code
npm run test:cov                        # Run tests
npm run check:tsc                       # Type-check
npm run lint:strict                     # Lint code
npm run build                           # Run production build
npm run start:prod                      # Check production execution

About

⏭️ Modern Next.js Template: Full-stack architecture, shared TS/Lint/Jest configs, Dependabot configuration and automated CI.

Topics

Resources

Stars

Watchers

Forks

Contributors