Skip to main content
1

Create a new database

By default, ShipThing uses Neon as its database provider and Prisma as its ORM.Make sure to have created a new database and have the connection string ready. For example when using PostgreSQL, the connection string will look something like this:
postgresql://<username>:<password>@<host>:<port>/<database>
2

Set up the environment variables

You can read more about environment variables here. set at least the DATABASE_URL
3

Configure the database

You will need to scaffold the database using the schema defined in packages/database/prisma/schema.prisma:
Terminal
pnpm migrate
For more details on the default Prisma configuration (using Neon), refer to the Database Configuration Guide.
The apps/api and apps/app application use the database as an example, if you need to build one of these applications then make sure that this step is completed successfully. Otherwise you can ignore this step for now
4

Start your development server

Now your app should be ready to go. To start the local development server, navigate into your project root folder and run the following command.
Terminal
pnpm dev
Open the localhost URLs with the relevant ports listed above to see the app, e.g. 🎉
If you only want to launch a particular app, you can use the following command:
  • pnpm --filter app dev - Launch the Main app
  • pnpm --filter web dev - Launch the Landing page website
  • pnpm --filter api dev - Launch the API
  • pnpm --filter storybook dev - Launch the Storybook
  • pnpm --filter email dev - Launch the Email previews
  • pnpm --filter database dev - Launch the Prisma Studio