README.md

Imatex

"Optical Character Recognition". It is a technology that allows the conversion of different types of documents, such as scanned documents, images or documents captured by a camera, into editable text.

Table of Contents

• Features
• Tech Stack
• Installation
• Usage
• Deployment
• Notes

Features

• Extract Image From Documents
• Extract Text From Images
• Download Youtube Video
• Download Tiktok Video

Tech Stack

• .NET 8+
• Tesseract 5+
• Visual Studio 2022+

Installation

To get started with the project, follow these steps:

Restore all packages:

1. Clone the repository:

   git clone https://github.com/jmatoso/Imatex.git
   cd Imatex

2. Restore dependencies:

   dotnet restore

3. Set up environment variables: Change the appsettings.json file Imatex.Web and add the following variables:

   "GoogleTagId": "${GoogleTagId}",
   "TikTokOptions": {
       "TikTokDownloadApi": "${TikTokApi}",
       ...
   }

Usage

To start the development server, set Imatex.Web as startup project or run:

dotnet run

Deployment

The site is hosted on Render and the database on Aiven. Follow these steps for deployment:

1. Set up your Render account and create a new web service.
2. Link your GitHub repository to Render.
3. Add the required environment variables in Render's dashboard.
4. Deploy the application directly from the Render dashboard.

or

Notes

Render free instances might not be enough to run the app properly, but you can still try. Good Luck! :)