The Yoruba API is a comprehensive platform for English-Yoruba translations, cultural proverbs, and linguistic services. It leverages modern asynchronous web frameworks and artificial intelligence to provide high-quality language processing capabilities.
This project is structured as a monorepo to support core services, infrastructure, and future web applications.
- core/api: The main FastAPI application providing the RESTful interface.
- core/scripts: Utility scripts for database management and data generation.
- infra/docker: Containerization configurations for local and production environments.
- infra/k8s: Kubernetes manifests for high-availability deployments.
- infra/nginx: Reverse proxy and SSL configurations.
Detailed documentation is available in the web/docs/ directory:
- Project Features: Detailed breakdown of capabilities.
- Setup Guide: Instructions for local development and run commands.
- About the Project: Mission overview and project scope.
- AI Implementation: Technical details on the GPT-4o integration.
- CI/CD and Docker: Guide to deployment pipelines and containerization.
- Python 3.8+
- Docker (optional, for containerized development)
The root directory contains a Makefile that orchestrates common tasks.
# Install dependencies
make install
# Initialize database
make db-init
# Start server
make runThe API will be accessible at http://127.0.0.1:8000 with interactive documentation at /docs.
To ensure code quality and system reliability, use the following commands:
# Run test suite
make test
# Perform linting
make lint
# Run security checks
make securityYoruba API is an open-source initiative dedicated to preserving and empowering the Yoruba language in the digital age.