Getting Started

Git

Git is a version control system that is used to track changes in any file.

If Git is not installed, download it from the Git official website.

# Check if Git is installed
git --version

Node.js

Node.js is a runtime environment that allows you to run JavaScript code.

If Node.js is not installed, download it from the Node.js official website.

# Check if Node.js is installed
node --version

PNPM

Package manager is a tool that is used to manage dependencies in your project. We recommend using pnpm.

# Install pnpm if you haven't already
npm install -g pnpm

# Check pnpm version
pnpm --version

Set up your project

Clone the repository from GitHub:

git clone https://github.com/MkFastHQ/mkfast-template.git your-project-name

cd your-project-name

Remove the original remote connection and link to your own GitHub repository:

# Remove the original remote
git remote remove origin

# Create a new repository on GitHub, then link to your new repository
git remote add origin https://github.com/your-username/your-project-name.git

# Push the code to your new repository
git push -u origin main

Set up environment variables

Copy the .env.example file to .env as a starting point.

cp .env.example .env

Open the environment file and set the variables to your desired values. You can find more information about the environment variables in the Environment Configuration guide.

Install dependencies

Install the dependencies by running the following command:

pnpm install

Start the development server

Now that you have the environment variables set up, you can start the development server by running the following command:

pnpm dev

This will start the development server on http://localhost:3000 and you can access the template website.