Clear Read Hub

Clear Read Hub is a microservice architecture application built with FastAPI, following the principles of Domain-Driven Design (DDD).

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Python 3.11
• Pip
• FastAPI
• MongoDB

Installing

A step by step series of examples that tell you how to get a development environment running.

# Clone the repository
git clone https://github.com/luigi-dv/clear-read-hub.git

# Navigate into the directory
cd clear-read-hub

# Install dependencies
pip install -r requirements.txt

# Run the application
uvicorn main:app --reload

Docker

You can also run the application using Docker.

# Build the image
docker build -t clear-read-hub:latest .
# Run the container
docker run -p 8000:8000 clear-read-hub:latest
# Run the container in detached mode
docker run -d -p 8000:8000 clear-read-hub:latest

Running the tests

Explain how to run the automated tests for this system.

Deployment

Add additional notes about how to deploy this on a live system.

Built With

• FastAPI - The web framework used
• Python - The programming language used

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Luigi Davila

See also the list of contributors who participated in this project.

License

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