Skip to main content

Quickstart

Creating a Telepath project requires the following things:

  1. Telepath user account. You can sign up here.
  2. Node.js version 14.x or higher.

Initialize Project via CLI​

The fastest way to get started is to create a new Project using the Telepath CLI. This process will simultaneously create a new Project with the Telepath backend and generate the files needed to get started.

Run the quickstart from your shell / terminal:

  1. Run npx @telepath/cli login to login to your Telepath user account.
  2. Run npx @telepath/cli init to create your first project.
  3. A new sub-directory with your project’s files will be created with your project name. Check out the README and sample index.ts file to learn how to deploy your project.

Manually Create Project​

It’s a lot easier to get started using the CLI quickstart documented above, but you can also do things manually, if you want.

This journey isn’t currently documented, but if you’re familiar the basics of Node/Typescript projects, you can find a sample project in this GitHub repo.