einjunge99 / api

Fast-API + Firebase

Sign Language API

This project is a FastAPI-based application designed to provide services for sign language learning. The application can be containerized using Docker and uploaded to Google Cloud's Artifact Registry.

Table of Contents

• Prerequisites
• Installation
• Running the API
• Building and Pushing Docker Image
  • Step 1: Authenticate with Google Cloud
  • Step 2: Build the Docker Image
  • Step 3: Tag the Docker Image
  • Step 4: Push the Docker Image

Prerequisites

Before you begin, ensure you have the following installed on your machine:

• Docker
• Google Cloud SDK
• Python 3.7+
• FastAPI and other dependencies listed in requirements.txt

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/sign-language-api.git
   cd sign-language-api

2. Install the dependencies:

   pip install -r requirements.txt

Running the API

To run the API locally, execute the following command:

uvicorn main:app --reload

The API will be accessible at http://127.0.0.1:8000.

Building and Pushing Docker Image

Step 1: Authenticate with Google Cloud

First, authenticate your Docker client to your Google Cloud project:

gcloud auth login
gcloud auth configure-docker us-west4-docker.pkg.dev

Step 2: Build the Docker Image

Build the Docker image with the following command:

docker build --platform linux/amd64 -t sign-language-api .

Step 3: Tag the Docker Image

Tag the Docker image to prepare it for uploading to Google Cloud Artifact Registry:

docker tag sign-language-api us-west4-docker.pkg.dev/sign-language-learning/sign-language/sign-language-api:latest

Step 4: Push the Docker Image

Finally, push the Docker image to the registry:

docker push us-west4-docker.pkg.dev/sign-language-learning/sign-language/sign-language-api:latest

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

We welcome contributions! Please read our Contributing Guidelines for more details.

Contact

If you have any questions or suggestions, feel free to open an issue or reach out to the project maintainers.

---

Note: Replace placeholder URLs and project-specific information as necessary.