https://github.com/kumarryogeshh/fast-api

https://github.com/kumarryogeshh/fast-api

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kumarryogeshh/fast-api
• Owner: kumarryogeshh
• Created: 2024-09-05T16:06:40.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-11-19T15:30:12.000Z (7 months ago)
• Last Synced: 2025-01-21T11:28:37.591Z (5 months ago)
• Language: Python
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Python FastAPI Simple Rest API Application

This project is a simple REST API built with FastAPI.

## Project Setup

Follow these steps to set up and run the project:

1. Clone the repository:

   ```

   git clone 

   cd fast-api

   ```

2. Create a Python virtual environment:

   ```

   python -m venv venv

   ```

3. Activate the virtual environment:

   - On Windows:

     ```

     venv\Scripts\activate

     ```

   - On macOS and Linux:

     ```

     source venv/bin/activate

     ```

4. Install dependencies:

   ```

   pip install -r requirements.txt

   ```

5. Start the application:

   ```

   uvicorn main:app --reload

   ```

The API will be available at `http://localhost:8000`. You can access the following endpoints:

- Home page: `http://localhost:8000/`

- About page: `http://localhost:8000/about`

To view the interactive API documentation, go to `http://localhost:8000/docs`.