Getting Started


1. Clone the Repository

You can download the project repository as a zip file or clone it using Git. We recommend using Git, as it will make it easier for you to pull updates in the future.

After granting access to the Full-Stack-Kit repository, clone the project using Git, to create your app from the Full-Stack-Kit template.:

git clone my-app

Change directory to the project folder:

cd my-app

Rename the origin remote to full-stack-kit:

git remote rename origin full-stack-kit

2. Create your own new GitHub Repository

Create a new git repository on your Github account to host your project. Then follow the steps below to push the project to your repository.

After creating a new repository on your Github account, do the followings.

  • Copy the url of your repository that you just created, and add it as a remote to the project:
git remote add origin [your-repository-url]
  • Push the project to your repository:
git push -u origin main

Now you can pull future updates from our repository using the following command:

git fetch full-stack-kit
git merge full-stack-kit/main

2. Prerequisites

Make sure you have the following prerequisites installed on your machine:

For a better development experience, we recommend installing the following tools:

3. Configure Environment Variables

Create a .env.local file in the root directory of your project. Copy the content from .env.sample and paste it into .env.local. This file will hold your environment-specific configurations.

4. Install Dependencies

Run the following command to install project dependencies:

npm install

or if you prefer using yarn:


5. Start the Server

Run the following command to start the server:

npm run dev

or if you prefer using yarn:

yarn dev

This will launch the development server, and you can access your application at http://localhost:3000 (opens in a new tab).

Now you're ready to explore and customize Full-Stack-Kit. If you have any questions or run into issues, refer to the documentation or reach out to our community for assistance.

Full-Stack-Kit © 2024