Skip to content

README.md

Latest commit

 

History

History
40 lines (28 loc) · 1.27 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.27 KB

Pumble SDK

Ask DeepWiki

This repository contains the tools to create Pumble apps.

  1. Pumble SDK - A javascript framework to quickly build Pumble apps.
  2. Pumble CLI - A cli tool to generate and run Pumble apps from your local environment.

Read the full documentation to get started.

Quick Start

npm i -g pumble-cli

After successfully installing pumble-cli use the command below to log in to your workspace

pumble-cli login

You will be asked to input your email address and you will receive a code in your inbox. After logging in you can proceed to create your first Pumble App.

pumble-cli create

This command will ask you to type a name and description and will generate the project.
After this command has completed you can then cd into the generated directory and start the addon.

cd my_app
npm run dev

If you login into Pumble you will see your App is installed and ready to use.

Tip

You can also skip installing pumble-cli and use npx pumble-cli create instead