Markkos89 / phala-hackaton-monorepo

Project repo built for the @developer-dao and @phala-network hackaton sept 2023 - w/ @peteruche21 & @HAPPYS1NGH

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/pwa-app: a Next.js app with Tailwind CSS
• apps/claim-app: another Next.js app with Tailwind CSS
• apps/lens-oracle: a Hardhat project for the Consumer Contract that is compatible with a deployed LensAPI Oracle
• apps/lens-api-code-examples: an app with code examples for the LensAPI
• packages/ui: a stub React component library with Tailwind CSS, shared by both pwa-app and claim-app apps
• packages/utils: utilities shared by both pwa-app and claim-app 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:

npx degit markkos89/turbo-monorepo-template my-monorepo
cd my-monorepo
pnpm install

Develop Next.js

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

pnpm dev

Build Next.js

If you want to build apps/pwa-app and apps/claim-app for production, run at the root:

pnpm build

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/pwa-app and apps/claim-app, 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