Documentation

Getting Started

This guide will take you through the steps of setting up spiralsaas. It will include cloning the project, installing dependencies, setting up your database, and running the local development server.

Prequsites

Before you can get started, you will need to have the following installed on your machine.

Cloning the repository

To clone the repository, run the following command in your terminal.

git clone git@github.com:bleedingAyush/nextjs-starter-kit-spiralsaas.git

Note: If your SSH key is not set up, you can use the HTTPS URL instead.

git clone https://github.com/bleedingAyush/nextjs-starter-kit-spiralsaas.git

Configuring Git remotes

After cloning the repository, remove the original origin remote:

git remote remove origin

Add the upstream remote pointing to the original repository to pull updates:

git remote add upstream https://github.com/spiralsaas/spiralsaas.git

Once you have your own repository set up, add your repository as the origin:

git remote add origin <your-repository-url>

Execute the following command to fetch updates from the main repository.

git pull upstream master

Install npm dependencies

npm install

Starting the development server

To start the development server, run the following command in your terminal.

npm run dev

On this page