README.md

FastAPI Vercel Example

This Example Code is a Part of an Article: Simple Guide on Deploying Python FastAPI on Vercel — Free of Cost

---

Live Url: Deployment

Article Link: Medium

---

Introduction:

Whether you’re working on a hobby project or a professional endeavor, deployment is essential. FastAPI, a high-performance web framework for building APIs with Python, offers an efficient way to handle concurrent tasks using asynchronous programming. In this guide, we’ll explore deploying a FastAPI application on Vercel, which provides a straightforward interface for continuous deployment, and the best part—it’s free!

Steps for Deployment:

1. Initialize the Project:

• Create a new project directory (e.g., flask-api-example).
• Set up a virtual environment (optional but recommended).
• Install Python dependencies specified in the requirements.txt file.

2. Write the API:

• Create an index.py file within a directory (e.g., api).
• Define your FastAPI routes and endpoints (e.g., a simple “Hello World” response).

3. Configure .gitignore:

• Initialize a Git repository.
• Add a .gitignore file to exclude specific files and directories (e.g., IDE-related files, cache, and virtual environments).

4. Create vercel.json:

• Add a vercel.json file at the root of your app.
• Specify the build process and routes for Vercel deployment.

5. Deploy on Vercel:

• Using Vercel CLI:
  • Install Vercel CLI globally (npm i -g vercel).
  • Log in to the CLI using vercel login.
• Deploy using vercel commands.
  • Using GitHub/GitLab Integration:
  • Connect your Vercel account to your Git repository.
  • Automatically deploy on every push to the repository.

Conclusion:

By following these steps, you can deploy your Python FastAPI application on Vercel without any cost. Enjoy hassle-free deployment and focus on building great APIs! 🚀.

Result: