🇺🇸 English | 🇧🇷 Português

🔖 Overview

This is a minimal Next.js application based on the Quick Start Guide in the Next documentation. Use this app to help you get started and not have to do all the boring settings and focus on what matters to code 😍

• Getting started
• Reminder
• Technologies
• Development Stream
• License

🖥️ Browsers Support

This project is designed to work with modern browsers and Internet Explorer 11. Here's a breakdown of supported browsers:

IE / Edge	Firefox	Chrome	Safari	Opera
last versions	last versions	last versions	last versions	last versions

Server-side Rendering

This project supports server-side rendering (SSR) for the following browsers:

• Internet Explorer 11, Edge
• Firefox
• Chrome
• Safari
• Opera

🏃‍♂️ Getting Started

Prerequisites

Before starting, you will need to have the following tools installed on your machine:

The project can be built with npm or yarn, so choose one of the approach bellow in case you don't have any installed on your system.

• Npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. Download Node.js

• Yarn is a package manager built by Facebook Team and seems to be faster than npm in general. Download Yarn

Besides, it's nice to have an editor to work with code like VSCode

🧭 Running the web application (Frontend)

# Clone this repository
$ npx create-next-app [project-name] --example https://github.com/NatanaelBorges/next-quick-start

# Access the project folder on your terminal/cmd
$ cd [project-name]

# Install dependencies
$ npm install

# Run the application in development mode
$ npm run start

# The application will open at the door:3000 - access http://localhost:3000

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

( back to the top )

⏰ Reminder

Don't forget to change the project name and version in 👉 package.json to your project name and your project version.

💾 Technologies

The following tools were used in the construction of the project:

• Next.js
• TypeScript
• Tailwindcss
• Husky
• Jest.js
• Commitlint
• ESLint
• Prettier
• Release-it

See the file package.json

( back to the top )

💻 Development Stream

Before starting to develop, update the libraries, as there may be newer versions available. I like to use this command npm outdated and update lib by lib, so I can know if any lib has undergone any major changes.

Main Commands

Command	What it does
npm run dev	Execute the project
npm test	Execute the tests
yarn dev	Execute the project (Yarn)
yarn test	Execute the tests (Yarn)
yarn upgrade	Update project dependencies with Yarn

( back to the top )

📝 License

This project is under the MIT license.

Made with ❤️ by Natanael Borges 👋🏽

( back to the top )