README.md

Next.js & Tailwind CSS Monorepo Template

This is a monorepo template using:

• 📏 TypeScript 5.0
• ⚡️ Next.js 13.2
• ⚛️ React 18.2
• 🌬️ Tailwind CSS 3.3
• 📕 Storybook 7.0
• 🧪 Testing Library
• 🃏 Jest
• 🎭 Playwright
• 💡 Lighthouse
• 🧹 ESLint
• 🤖 CommitLint
• 💖 Prettier
• 📦 pnpm
• 🏎️ Turborepo
• 👷 Github Actions

What's inside?

This monorepo includes a few apps and packages.

Apps and Packages

• apps/website-ssr: a Next.js app with Tailwind CSS
• apps/website: another Next.js app with Tailwind CSS
• packages/ui: a stub React component library with Tailwind CSS, shared by both website-ssr and website apps
• packages/utils: utilities shared by both website-ssr and website apps
• packages/eslint-config-custom: shared ESLint configuration
• packages/jest-config: shared Jest configuration
• packages/lighthouse-config: shared Lighthouse configuration
• packages/next-config: shared Next.js configuration
• packages/playwright-config: shared Playwright configuration
• packages/storybook-config: shared Storybook configuration
• packages/tailwindcss-config: shared Tailwind CSS configuration
• packages/typescript-config: shared tsconfig.json files

Using this template

Run the following command:

git clone https://github.com/Developer-DAO/academy-turbo
cd academy-turbo
pnpm install

Develop Next.js

If you want to start apps/academy in development mode, and watch for changes in packages/ui, run at the root:

pnpm dev --filter academy

Build Next.js

If you want to build apps/academy for production, run at the root:

pnpm build --filter academy

If you want to see an analysis of the generated bundles, specify the ANALYZE environment variable:

ANALYZE=true pnpm build

Preview Next.js

If you want to preview production builds of apps/website-ssr and apps/website, run at the root:

pnpm start

Develop Storybook

If you want to start all Storybook projects in development mode, run at the root:

pnpm storybook:dev

Develop Storybook

If you want to build all Storybook projects, run at the root:

pnpm storybook:build

Unit tests

If you want to run unit tests for all projects, run at the root:

pnpm test:unit

End-to-end tests

If you want to run e2e tests for all projects, run at the root:

pnpm test:e2e

Lint

If you want to run linting for all projects, run at the root:

pnpm lint