Getting Started
Let's get you up and running with Celerity in less than 5 minutes.
Getting Started
Get started by creating a new Celerity application.
Install Celerity
To install Celerity on macOS, Linux or another Unix-like OS, run the following command in your terminal:
curl --proto "-https" --tlsv1.2 -sSf https://manager-sh.celerityframework.io | sh
Using a different system or want to install another way? Check out other ways to install Celerity for your platform here.
This will run a shell script to install the celerity-manager tool that will then install the Celerity CLI, Bluelink Deploy Engine, a set of core Deploy Engine plugins and the Blueprint Language Server on your system.
As Celerity consists of multiple software components, the celerity-manager tool makes it easier to install them and manage updates.
Generate a new project
Generate a new Celerity application using the simple API template:
celerity app init --template simple-api my-app
You will be prompted to select a programming language for your application, before the project can be generated. Celerity provides template projects for languages with official SDK support, including:
- Python
- Node.js (TypeScript)
- Java
- C# (dotnet)
- Go
- Rust
See the runtime documentation for more information and to see how you can implement Celerity applications in other languages.
Start your API locally
Run the development server:
cd my-app
celerity app start
The API will now be available at http://localhost:3005.
You can test the simple API users endpoint with a GET request to http://localhost:3005/users.
Edit some source code for the users endpoint: the API will reload automatically and you can check by re-running GET /users request.
Dive Deeper
Now that you have a Celerity application up and running, you can dive deeper into the documentation to learn more about the framework and its features.