Skip to content

KXN2004/EscrowBackend

Folders and files

NameName
Last commit message
Last commit date
Mar 12, 2024
Mar 1, 2024
Mar 2, 2024
Feb 29, 2024
Feb 29, 2024
Mar 2, 2024
Mar 2, 2024
Feb 28, 2024
Mar 2, 2024
Feb 28, 2024
Mar 2, 2024
Feb 29, 2024

Repository files navigation

FastAPI Backend

This is a basic FastAPI backend project.

Description

This project demonstrates how to create a simple backend using FastAPI, a modern, fast (high-performance), web framework for building APIs with Python 3.7+.

Features

  • User authentication
  • CRUD operations for managing resources
  • Docker containerization for easy deployment

Prerequisites

  • Python 3.7+
  • pip (Python package manager)
  • Docker (optional, for containerization)

Installation

  1. Clone the repository:

    git clone https://github.com/KXN2004/EscrowBackend.git
  2. Navigate to the project directory:

    cd EscrowBackend
  3. Install the required dependencies:

    pip install -r requirements.txt

Usage

  1. Start the FastAPI server:

    uvicorn main:app --reload
  2. Open your web browser and go to http://localhost:8000/docs to access the Swagger UI for interacting with the API.

Configuration

  • Modify the config.py file to configure settings such as database connection, authentication, etc.

Contributing

Contributions are welcome! Please feel free to open a pull request or submit an issue.

License

This project is licensed under the MIT License.