Skip to content

Setup Instructions

Jump to bottom
Linda Thompson edited this page Mar 31, 2023 · 1 revision

Prerequisites

CLI Method (Recommended)

Starter.dev has it's own CLI that you can use to create a project using one of our starter kits. The command should work with npm, yarn, or pnpm, so feel free to use whichever you'd prefer.

The CLI automatically runs in interactive mode, which will let you view the full list of available kits and prompt you to name your new project. This command works for both frontend and backend kits.

npm create @this-dot/starter

We also have two available flags, that will let you directly specify the kit you'd like to use and the project name you want.

# npm 6.x
npm create @this-dot/starter --name my-project --kit angular-apollo-tailwind

# npm 7+, extra double-dash is needed:
npm create @this-dot/starter -- --name my-project --kit next12-chakra-ui

# can also pass only one option:
npm create @this-dot/starter -- --kit serverless-framework-apollo-contentful

# yarn
yarn create @this-dot/starter --name my-project --kit qwik-graphql-tailwind

Manual setup

| Note: The command below clones the entire repository, including all starter kits.

git clone https://github.com/thisdot/starter.dev.git

The kits are located within the starters folder. To pick the one you'd like to use and create your new project:

  • Copy the starters/<kit-id-name> starter kit you want and paste it wherever you'd like your project to live.
  • Rename the project from <kit-id-name> to the name you want for your project.

Initializing the project

Each kit's README will have the specific directions for that kit, but generally the process is:

  • Change into your new project's root folder
  • Install the dependencies with npm install
  • Configure any variables that might need to be setup
  • Each kit will have a dev or start command you can run to get the project started locally
Clone this wiki locally