Orbiter Backend

The Orbiter API is a collection of RESTful endpoints that power all of the website hosting functionalities for Orbiter. Contributions are welcome. Please see the API docs here.

Running the API locally

In order to run the API locally, you need Node.js v20 or higher. Then, follow the steps below:

1. git clone https://github.com/orbiterhost/orbiter-backend
2. cd orbiter-backend
3. npm i

You will need to update the wrangler.toml file in the root of the project and change the following variables to match your account:

RECAPTCHA_SITE_KEY = "" // Get from Google Recaptcha setup
ZONE_ID = "" // Cloudflare Zone ID associated with the worker you will be using to power this API
HOST_ZONE_ID = "" // Get from Cloudflare
SUPABASE_URL = "" 
PINATA_GATEWAY = ""
CHANNEL_ID = "" //  Slack Channel ID for malicioud content updates
SLACK_SITES_CHANNEL_ID = "" // Slack Channel ID for site updates
SLACK_SUBSCRIPTIONS_CHANNEL_ID = "" //  Slack Channel ID for billing updates
ORBITER_WALLET_ADDRESS = "" // EVM wallet address for smart contract management
CONTRACT_ADDRESS = "" // IPCM contract factory address
NGINX_SERVER_URL = ""
SITE_DOMAIN = ""
RESOLVER_ADDRESS = "" //    ENS Resolver Contract address
LAUNCH_MONTHLY_PRICE_ID = ""
LAUNCH_YEARLY_PRICE_ID = ""
ORBIT_MONTHLY_PRICE_ID = ""
ORBIT_YEARLY_PRICE_ID = ""

[[kv_namespaces]]
binding = "ORBITER_SITES"
id = ""

[[kv_namespaces]]
binding = "SITE_PLANS"
id = ""

[[kv_namespaces]]
binding = "SITE_TO_ORG"
id = ""

To get the IDs for the kv_namespaces you will need to use the Cloudflare Wrangler CLI to initialize the KV. See the docs here.

You will also need to create a .dev.vars file and add the following variables:

ORBITER_ANALYTICS_TOKEN = ""
STRIPE_KEY = ""
ENDPOINT_SECRET = ""
LOOP_TEST_ENDPOINT_SECRET = ""
LOOP_ENDPOINT_SECRET = ""
LOOPS_API_KEY = ""
ENS_SIGNER = ""
NGINX_IP = ""
ORBITER_PRIVATE_KEY= ""
NGINX_SERVER_TOKEN= ""
SLACK_TOKEN = ""
SUPABASE_SERVICE_ROLE_KEY = ""
SUPABASE_WEBHOOK_SECRET = ""
PINATA_JWT = ""
CLOUDFLARE_API_TOKEN = ""
RECAPTCHA_SECRET_KEY = ""

To run the API once you've completed the above, simply enter the following command:

npm run dev