Installation

Learn how to clone the repository and install the boilerplate.

Make sure you have read and followed the instructions on requirements before proceeding.

Instructions

Clone the repository

Once you've gained access to the repository after purchasing AI Boilerplate, clone it:

git clone https://github.com/aiboilerplate/aiboilerplate.git
git clone git@github.com:aiboilerplate/aiboilerplate.git

Update the remote

In order to receive future updates from the boilerplate repository, update the remote:

git remote rm origin
git remote add upstream https://github.com/aiboilerplate/aiboilerplate.git
git remote rm origin
git remote add upstream git@github.com:aiboilerplate/aiboilerplate.git

Create your own repository on GitHub and add it as the origin:

git remote add origin https://github.com/your-username/your-repository-name.git
git remote add origin git@github.com:your-username/your-repository-name.git

Now you have two remotes: origin (your repository) and upstream (the boilerplate repository).

You can pull the latest changes from the boilerplate repository using the following command:

git pull upstream main

Install dependencies

pnpm install

This also sets up Husky, which runs pre-commit hooks to enforce code quality with ESLint and Prettier.