zigou23 / koyeb-fastapi

koyeb

Koyeb Serverless Platform

Deploy a Python FastAPI application on Koyeb
Learn more about Koyeb · Explore the documentation · Discover our tutorials

About Koyeb and the Python FastAPI example application

Koyeb is a developer-friendly serverless platform to deploy apps globally. No-ops, servers, or infrastructure management. This repository contains a Python FastAPI application you can deploy on the Koyeb serverless platform for testing.

This example application is designed to show how a Python FastAPI application can be deployed on Koyeb.

Getting Started

Follow the steps below to deploy and run the Python FastAPI application on your Koyeb account.

Requirements

You need a Koyeb account to successfully deploy and run this application. If you don't already have an account, you can sign-up for free here.

Deploy using the Koyeb button

The fastest way to deploy the Python FastAPI application is to click the Deploy to Koyeb button below.

Clicking on this button brings you to the Koyeb App creation page with everything pre-set to launch this application.

To modify this application example, you will need to fork this repository. Checkout the fork and deploy instructions.

Fork and deploy to Koyeb

If you want to customize and enhance this application, you need to fork this repository.

If you used the Deploy to Koyeb button, you can simply link your service to your forked repository to be able to push changes. Alternatively, you can manually create the application as described below.

On the Koyeb Control Panel, click the Create App button to go to the App creation page.

1. Select GitHub as the deployment method to use
2. In the repositories list, select the repository you just forked
3. Specify the branch to deploy, in this case main
4. Then, give your service a name, i.e fastapi-on-koyeb
5. Click Deploy

You land on the deployment page where you can follow the build of your FastAPI application. Once the build has completed, your application is deployed and you will be able to access it via <YOUR_APP_NAME>-<YOUR_ORG_NAME>.koyeb.app.

Contributing

If you have any questions, ideas or suggestions regarding this application sample, feel free to open an issue or fork this repository and open a pull request.

Contact

Koyeb - @gokoyeb - Slack - Community