Skip to main content

Creating an App

In this section, we will show you how to create a Busy Hour App.

Prerequisites

  1. Busy Hour Account (Sign Up if you don't have one yet)
  2. Generate a Master/Project API Key from Dashboard/Settings or from Dashboard/Projects

Creating an App

warning

You can create a Busy Hour App with any Master API Key or a Project API Key that only specificly for the project app you want to create.

To create a Busy Hour App, you can use the app.create function from the @busy-hour/node package. The function take an object with the following properties:

PropertyTypeDescription
projectIdstringThe ID of the project that the app will belong to
displayNamestringThe name of the app
platformweb | android | iosThe platform of the app will be deployed to
bundleIdstring (optional)The bundleId of the app will be deployed to, set to null if the platform is web

Quick Example

src/main.ts
import { BusyHourNode } from '@busy-hour/node';

// Create an instance of BusyHourNode with your API key (Master/Project)
const nodeSdk = new BusyHourNode({
apiToken: 'your-api-token',
});

nodeSdk.app.create({
payload: {
projectId: 'your-project-id',
displayName: 'My Project',
platform: 'web',
bundleId: null,
},
});