Getting Started

Here is a quick start guide.

To see the demo live - go to webappboost-pro.vercel.app (opens in a new tab).

Prerequisites

Make sure the following are installed on your system

Node.js (opens in a new tab) - ^18.18.0 is recommended;
pnpm (opens in a new tab) - necessary for managing workspaces in the monorepo;
VSCode (opens in a new tab) - your favourite code editor;
Download - you have downloaded this template.

Installation

Initialise Git repository

git init

Install all dependencies

pnpm install

Copy the env file

cp .env.example .env

The .env file in the root will be created, then update ENV variables, following the structure of .env.example. You may need to read through the Features section to learn how to obtain the necessary keys.

If you use CI, for example, GitHub Actions, make sure that you create the .env file with the correct variables on CI as well. By default the create-env-file GitHub Action copies .env.example with the default values.

Run the development server

pnpm dev

Open http://localhost:3000 (opens in a new tab) with your browser to see the result.

Congratulations, you're ready to go! 🎉

Next Steps

See the complete list of available Features to learn how to set up any specific functionality.

Introduction Features