Getting started

Prerequisites

Before you can start using staarter.dev, you need to have the following tools installed on your machine:

• Node.js (version 20 or higher)

• Yarn (version 1.22 or higher)

• Git

• Visual Studio Code (or any other code editor, but VS Code is recommended)

Also, make sure you have the following accounts set up:

• GitHub account (for cloning the repository)

Clone the Repository

To begin, clone the staarter.dev repository to your local machine using the following command in your terminal:

Make sure to replace [project-name] with the name of your project.

Using the Template

Create a new repository from this template on GitHub. After creating the repository, clone it to your local machine using the following command:

git clone [repository-url]

Replace [repository-url] with the URL of the repository you created from the template.

Using HTTPS

git clone https://github.com/staarter-dev/next-template.git [project-name]

Using SSH

git clone [email protected]:staarter-dev/next-template.git [project-name]

Move into the Project Directory

cd [project-name]

Set your Own Remote

Skip this step if you are using the template repository.

After cloning the repository, you should set your own remote to push your changes to your own repository. You can do this using the following commands:

git remote set-url origin [your-repository-url]

Add the upstream remote

To receive updates from the staarter.dev repository, you need to add the upstream remote to your Git repository. You can do this using the following commands:

Using HTTPS

git remote add upstream https://github.com/staarter-dev/next-template.git

Using SSH

git remote add upstream [email protected]:staarter-dev/next-template.git

Install Dependencies

Once you have the project on your local machine, move into the project directory and install the necessary dependencies using Yarn:

yarn install

Fill in the Environment Variables

Next, you need to fill in the environment variables. Copy the .env.example file to .env.local and fill in the required values:

cp .env.example .env.local

For more information on setting up environment variables, refer to the Environment Variables documentation.

Start the Development Server

After the installation is complete, you're ready to start developing! Run the following command to start your local development server:

yarn dev

The development server will start, and you can access your project at http://localhost:3000.