README.md

🦁 Next.js Boilerplate

A boilerplate for projects using Next.js and TypeScript.

✨ Features

• Next.js 12, for all your production-ready React SSR (or Static) needs
• Google TypeScript Style, for consistent, readable code
• Husky, for pre-commit linting and build checks
• Issue Templates, to get you up and running in Open Source quickly

📄 Scripts

Run any of the following scripts using yarn:

yarn <script>

Script	Description
build	Build the Next.js application, ready to be ran with start
clean	Remove linter output files
dev	Start the Next.js application in hot-reloading mode, for development
fix	Automatically fix all linting issues in files
lint	Check all files, reporting them to the console
start	Start the Next.js application in production mode, requires build

🙋‍♂️ Don't have Yarn?

Install it using npm.

npm install --global yarn

⚙️ Environment Variables

Do not push sensitive keys to GitHub. You should follow Next.js' Guide for environment variables.

This includes:

• .env.local: Use a .env.local file for any sensitive keys. These should not be pushed to GitHub.
• .env: Use a .env file for any application configuration that can be safely committed to GitHub, such as a PORT value.

🌐 Exposing Environment Variables to the Browser

By default, Next.js will only load environment variables in the Node.js environment and not load them in the browser.

It may be the case that, in some circumstances, it is necessary to load these values in the browser. To do this, prefix the environment variable with NEXT_PUBLIC_:

NEXT_PUBLIC_ANALYTICS_ID=foo

🔨 Environment variables used in this application

Use this table to store and describe the environment variables used in your application so that others can maintain your application.

Key	Description	Required
PORT	The port that the application runs on.	No
NEXT_PUBLIC_FOO	An example value.	No

☁️ Hosting

This project comes with support for Firebase Hosting out of the box. This consists of:

• A root firebase.json file that holds the configuration for Firebase Hosting
• A .github/workflows/firebase-hosting.yml file, the GitHub Action that deploys your application to the Web

To use the application, provide your secret keys in the format specified on your repository's secrets.

You can find these by going to Settings -> Secrets -> New Repository Secret.

Key	Required
FIREBASE_SERVICE_ACCOUNT	Yes
FIREBASE_PROJECT_ID	Yes
FIREBASE_API_KEY	No
FIREBASE_AUTH_DOMAIN	No
FIREBASE_STORAGE_BUCKET	No
FIREBASE_MESSAGING_SENDER_ID	No
FIREBASE_APP_ID	No
FIREBASE_MEASUREMENT_ID	No