https://github.com/almirjnr/bonum
Http api with a tesseract ocr wrapper using containers with integrated xunit tests
https://github.com/almirjnr/bonum
aspnet-core docker-compose github-actions http-api masstransit rabbitmq tesseract-ocr xunit
Last synced: 7 months ago
JSON representation
Http api with a tesseract ocr wrapper using containers with integrated xunit tests
- Host: GitHub
- URL: https://github.com/almirjnr/bonum
- Owner: AlmirJNR
- Created: 2024-05-14T20:47:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-15T02:57:33.000Z (over 1 year ago)
- Last Synced: 2025-01-20T05:37:25.397Z (9 months ago)
- Topics: aspnet-core, docker-compose, github-actions, http-api, masstransit, rabbitmq, tesseract-ocr, xunit
- Language: C#
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bonum
#### _means "Good" in latin_
## What it is?
A http api with a tesseract ocr wrapper using containers with integrated xunit tests
## How to run it?
### Pre-requisites (run only):
- Docker and docker-compose
- Any http request tool (optional)(swagger is available if needed)
#### Steps:
1. Run `docker compose up` in your terminal
2. Access on your browser the address [http://localhost:5000/swagger](http://localhost:5000/swagger)
3. Use the swagger interface to send any supported image file to receive the extracted text as the response
### Pre-requisites (development):
- Docker and docker-compose
- Dotnet SDK 6.0.+
- Any IDE that works with Dotnet
#### Steps:
1. Run `docker compose up rabbitmq`
2. Start the `Bonum.Ocr` project
3. Start the `Bonum.Api` project
## Tests
Must have the [development pre-requisites](#pre-requisites-development)
#### Steps:
1. Run `dotnet test` in the [Src](Src) folder
2. (Alternative) Run the test using any IDE