Skip to content

Himalaypatel75/FastAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Certainly, here's a sample README.md file for a FastAPI course, including an image of the FastAPI logo and the commands to run the app and access the Swagger documentation:

# FastAPI Course

Welcome to the FastAPI course! In this course, you'll learn how to build blazing-fast web APIs with FastAPI.

[![image](https://github.com/Himalaypatel75/FastAPI/assets/92620524/b1f8b383-acd6-4637-a66e-c1161b529e40)](https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png)

## Getting Started

To get started with the course, follow these steps:

1. Clone this repository to your local machine:

   ```bash
   git clone <repository_url>
   cd fastapi-course
  1. Install the required dependencies:

    pip install -r requirements.txt

Running the App

You can run the FastAPI app using uvicorn. Use the following command:

uvicorn main:app --reload

This command will start the FastAPI application, and the --reload option will enable automatic reloading of the server when code changes are detected.

Swagger Documentation

FastAPI comes with built-in Swagger documentation for your API. You can access it by opening the following URL in your web browser:

Swagger Docs

This interactive documentation will help you explore and test the API endpoints easily.

Course Content

Feel free to explore the chapters in this repository to learn more about FastAPI.

Contributors

License

This course is licensed under the MIT License - see the LICENSE.md file for details.


Make sure to replace `<repository_url>` with the actual URL of your course repository. Also, ensure that you have the FastAPI logo image (`fastapi-logo.png`) in your repository directory or provide the correct path to the image.

This `README.md` file provides an introduction to your FastAPI course, instructions for getting started, running the app, and accessing the Swagger documentation. It also includes placeholders for chapters, contributors, and licensing information, which you can fill in as needed.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages