Skip to content

A small ready-made starter project for Next.js with TypeScript, Recoil, Sentry, server-side sitemap generator (next-sitemap), i18n (next-i18n), SEO, ESLint, Prettier and bundle analyzer (@next/bundle-analyzer)

License

Notifications You must be signed in to change notification settings

Syfract/Next.js-Boilerplate

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Getting Started

This project is on Yarn 3 and PnP-ready.

First, install the packages:

yarn install

You probably need to add a UI library to the project. For example:

yarn add @nextui-org/react

Then you need to set two environment variables: URL and API_URL.

URL is the domain that the project is going to be hosted on. API_URL is the API endpoint. Both need to be a complete URL with scheme and host.

Then you need to configure the Sentry by running the following command:

npx @sentry/wizard -i nextjs

Now the project is ready.

At last, run the development server:

yarn dev

Open 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.

Bundle Analyzer

You can analyze the production bundle of the project using the next-bundle-analyzer plugin.

Just set these environment variables when creating a production build of the project: NODE_ENV=development and ANALYZE=true.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

A small ready-made starter project for Next.js with TypeScript, Recoil, Sentry, server-side sitemap generator (next-sitemap), i18n (next-i18n), SEO, ESLint, Prettier and bundle analyzer (@next/bundle-analyzer)

Resources

License

Stars

Watchers

Forks