Getting Started
This guide walks you through deploying Crude Functions and creating your first serverless endpoint. By the end, you’ll have a working function responding to HTTP requests.
Prerequisites
Section titled “Prerequisites”- Docker installed on your machine
- A server or local machine to host the container
- Basic TypeScript familiarity (helpful but not required)
Quick Start
Section titled “Quick Start”1. Deploy
Section titled “1. Deploy”Run the Docker container and configure your base URL.
What you’ll do: Pull the image, set environment variables, and start the container. Takes about 2 minutes.
2. First-Time Setup
Section titled “2. First-Time Setup”Create your admin account and generate an API key.
What you’ll do: Access the web UI, create the first user, and set up API access for managing functions programmatically.
3. Your First Function
Section titled “3. Your First Function”Write a handler, register a route, and test it.
What you’ll do: Create a TypeScript function, register it as an HTTP endpoint, and call it. Covers the basics of parameters, POST requests, and logging.
What’s Next
Section titled “What’s Next”Once you have a function running, explore these topics: