Installation

Initialization

Run the JTBDOS init command:

Terminal

npx JTBDOS@latest init

You will be prompted for the project name and package manager.

Terminal

$ npx JTBDOS@latest init

┌  Let's start a JTBDOS project!
│
◇  What is your project named?
│  my-app
│
◇  Which package manager would you like to use?
│  pnpm
│
◇  Project initialized successfully!
│
└  Please make sure you install the Mintlify CLI and Stripe CLI before starting the project.

This will create a new directory with your project name and clone the repo into it. It will run a setup script to install dependencies and copy .env files. You can read more about environment variables here.

Database

You will need to scaffold the database using the schema defined in packages/database/prisma/schema.prisma:

Terminal

pnpm migrate

CMS

You will need to setup the CMS. Follow the instructions here, but the summary is:

Fork the basehub/JTBDOS template
Get your Read Token from the “Connect to Your App” page
Add the BASEHUB_TOKEN to your Environment Variables

Development

Run the development server with:

Terminal

pnpm dev

Open the localhost URLs with the relevant ports listed above to see the app, e.g.

http://localhost:3000/ — The main app.
http://localhost:3001/ — The website.
http://localhost:3002/ — The API.
http://localhost:3003/ — Email preview server.
http://localhost:3004/ — The docs

Introduction

Setup

Deployment

Initialization

Database

CMS

Development

​Initialization

​Database

​CMS

​Development

Initialization

Database

CMS

Development