☄️ vth

Quickstart

Getting started with vth

Getting started

The easiest way to create a vth project is with the create-vth CLI:

Create vth project

Run the following command for your package manager:

Terminal
npm create vth

Then follow the prompts.

Start the development server

Once you have created your project you can cd into it and run the development server:

Terminal
npm run dev

This will start Vite dev server you can visit at localhost:5173. It handles all client and API requests as well as hot refreshing for both frontend and backend.

First build

To build your project simply run the build script:

Terminal
npm run build

It will execute two Vite build commands to first build the client and then the server. You can then run the app just by simply executing the main entry which should be located in ./dist/index.js.

Manual setup

If you prefer not to use the CLI, you can manually setup your project with degit:

Clone the template

Clone the template from the repository:

Terminal
npx degit mrozio13pl/vth/templates/full

Rename .gitignore

Make sure .gitignore is working as expected:

Terminal
rename _gitignore .gitignore

Install dependencies

Terminal
npm install

Start the development server

You can now start the development server:

Terminal
npm run dev