Not another Next.js starter

This is a Next.js project template bootstrapped with create-next-app by Gian Luca Pecile.

🔋 What's included

🏎️ Getting Started

The project is based on Next.js, a React framework for production. It uses TypeScript and Tailwind CSS.

Commits are linted using Husky and commitlint, therefore conventional commits are mandatory in order to use the template's default config.

The package manager is pnpm, so you need to install it first using the following command:

make deps

This command will try to install pnpm globally using the existing npm version and then proceed to run pnpm install.

If you have pnpm installed globally already, you can run:

make install

Behind the scenes, this will do a pnpm install of the package.json dependencies, creating a node_module folder locally.

📨 Environment Variables

No environment variables are required to run the template. These should be added to a .env file in the root of the project and should be prefixed with NEXT_PUBLIC_ to be available in the client-side code.

NEXT_PUBLIC_YOUR_ENV_VARIABLE

The following table describes each environment variable:

Variable	Description
`NEXT_PUBLIC_YOUR_ENV_VARIABLE`	Example env variable.

Run the following command to create a .env file based on .env.example with the required environment variables:

make create_env

This will create a .env file with the required environment variables. Make sure to update the values of the variables in the .env file to match your environment.

👨‍💻 Development

To start a development build of the webapp, run:

make dev

This runs next dev, which starts the application in development mode with hot-code reloading, error reporting, and more.

Then open http://localhost:3000 with your browser to view the application.

Make sure to update environment variables in .env to match your environment. See .env.example for an example of which variables are required. For more information, see the Environment Variables section.

🧹 Linting

To lint the webapp, run:

make lint

This runs next lint, which runs ESLint on the pages and components in the webapp and reports any linting errors. Make sure to fix all linting errors before submitting a pull request.

🚚 Production

To run the production build of the webapp, run:

make build

This runs next build, which generates an optimized version of your application for production. HTML, CSS, and JavaScript files are created based on your pages. JavaScript is compiled and browser bundles are minified using the Next.js Compiler to help achieve the best performance and support all modern browsers¹.

Running the production build

To start the production build of the webapp, run:

make start

This runs next start, which starts the Node.js server. This server supports all Next.js features².

Alternatively, you can run:

make deploy

This runs next build && next start, which builds and starts the application in production mode.

Then open http://localhost:3000 with your browser to view the application.

Running in a different port

To run the webapp in a different port, run:

make start PORT=3069

or:

make deploy PORT=3069

This starts the application in production mode in port 3069.

🎀 Make it your own

To make this template your own, you SHOULD:

Update the name, description, author and repository fields in package.json.
Edit the site.ts file in the src/config folder to match your site's information.

⚙️ Site Config Options

The site.ts file contains the following options:

Option	Description
`title`	The title of the site.
`description`	The description of the site.
`emoji`	The emoji to be displayed as the favicon of the site.
`backgroundColor`	The background color of the site.
`themeColor`	The theme color of the site.
`siteUrl`	The URL of the site.
`mainNav`	The values to be used in the main navigation bar of the site with the shape `{ title, href }`.
`links`	Social media links to be used throughout the app, these include by default twitter, telegram, github and docs. Extend as needed.

✍️ Acknowledgements

Shadcn for ui, the beautifully designed components.
Manu Arora for aceternity ui components.

ityn / next-14-shadcn-template