/nextjs-template

Primary LanguageTypeScript

⚛️ Next.js Template

Next.js TypeScript Tailwind CSS ESLint

Template for creating a Next.js app with TypeScript, Tailwind CSS, and ESLint. Pre-configured with Vitest, React Testing Library and Cypress for testing.

🚀 Using this template

  1. Create your project based on this template:

    • a) If you want to create a GitHub repository, we would recommend to use the GitHub "Use this template" button and clone your newly created repository
    • b) If you don't want to create a GitHub repository, you can use the degit tool to clone this repository without the Git history: 
      npx degit JPerezC92/nextjs-template#main my-nextjs-app

  2. Start the app:

    cd my-nextjs-app    
pnpm install
pnpm dev

  3. Start coding!

🧪 Testing

Unit Testing

This template uses Vitest for unit testing. To run the tests:

pnpm test

Integration Testing

This template uses Cypress for integration testing. To run the tests:

pnpm cy:open

or

pnpm dev
pnpm cy:run

📦 Building for production

To build the app for production:

pnpm build

🧹 Linting

To lint the app:

pnpm lint

📝 Formatting

To format the app:

pnpm lint:fix

📚 Documentation