Skip to content

Latest commit

 

History

History
43 lines (23 loc) · 2.55 KB

README.md

File metadata and controls

43 lines (23 loc) · 2.55 KB
Raw

Borealis Next.js starter

This template repo is used to quickly boostrap Next.js projects for use in Borealis.

This project isn't intended to be open source and for people outside of Borealis to update/upgrade it. We just made the repo public for ease of use.

If you wish to use the template, feel free to do it, but it might have things baked in that you don't like so keep that in mind. This template assumes some specific libraries and folder structure are used. This works for us, but it might not fit your workflow and needs.

Repo structure

Template that is actually used by create-next-app is inside /template folder. This is done on purpose to split the general instructions for using this template generator and actual instructions you'll need when project is bootstrapped.

Requirements

Project generator command below assumes you have Volta installed. Volta is used for easy Node.js and npm version management and the ability to run this command with appropriate Node.js and npm versions.

If you don't have Volta installed, please make sure you are using Node.js v20.x and npm v10.x when using this template with create-next-app command. Volta is still highly advised because it makes all of this way easier.

Getting Started

Please make sure to follow all steps here. Each step is important to properly set up the project.

Create your project

Invoke create-next-app using this command:

volta run --node 20 --npm 10 npx --yes create-next-app@latest --use-npm --example https://github.com/borealis-agency/next-starter/tree/main/template

This will ask you for your project name and will create a folder with that name for you. If you have a project called "Petfood Webshop", just type "petfood-webshop" and that folder will automatically be created.

This command will make sure that this template is created using Node.js v20.x and npm v10.x. This is important because this command also installs npm dependencies and we want to install these with proper Node.js and npm versions.

Allow VSCode to use specific Typescript version

When opening the generated project inside VSCode for the first time, VSCode might ask to use project specific Typescript version. Please click "Allow" if you see this popup.

This adds some additional type safety and autocomplete for some Next.js specific features.

Running the project

All instruction on how to run the project will be in the project folder that's generated by the command above.