raph's opinionated batteries-included Next.js starter template.
What's in the box?
- Next.js
- TypeScript
- Linting (eslint + prettier config)
- Prisma
- PWA-ready (Disabled by default)
- SEO optimization
- TailwindCSS
- Database setup with Prisma + API server
Either click on the "Use this template" button on GitHub, or
Download this template and initialize a new repository:
git clone https://github.com/raphtlw/next-starter.git --depth=1 my-app
cd my-app
rm -rf .git
git initInstall dependencies:
npm iCopy .env.example to .env.local and prisma/.env.example to prisma/.env, open them and change the default values to the appropriate values for your project.
cp .env.example .env.local
cp prisma/.env.example prisma/.envRun development server:
npm run devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
pages— Next.js pagescomponents— Components that are re-used across the project.layouts— Layout components that are used across the project, seepages/index.tsxfor an example on how they are used.styles— Global styles that are used across the project, no CSS modules are to be stored there.public— Everything that is placed in the / of the website after building.lib— Utilities, types, interfaces, temporary mock data, etc.
Pull the latest version of this repository into your project like so:
git pull https://github.com/raphtlw/next-starter.gitPWA support is provided via next-pwa. You can enable it by flipping the PWA_ENABLED variable in the .env.local file to true.