Digitize Text

A React app that converts handwritten or printed text on paper to computer text (digitizing it) taking off all that effort to type long text to the computer giving you a faster and easier way to get things done.








· Report Bug

· Request Feature

Table of Contents

• About the Project
• Built With
• Getting Started
• Prerequisites
• Installation
• Usage
• Contributing
• License
• Contact

About The Project

This is a full-stack project with web and native apps developed with React, React Native, TypeScript, and NodeJS, it uses the webcam/camera to snap a picture of handwritten or printed text on paper or gets an image that you upload and converts it to a formatted digitized version on the computer, it makes use of the Google Cloud Vision API for character recognition, NestJS in the backend and PostgreSQL as the database.

A second feature that will be added in the future it the ability to tell in which language a piece of text has been written after scanning it.

Built With

• ReactJS

• React Hooks

• React Native

• TypeScript

• Material UI

• Linaria

• NestJS

• PostgreSQL

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• This project uses yarn

npm install yarn -g

Installation

1. Clone the repo and cd into it

git clone git@github.com:Redvanisation/digitize-text.git
cd digitize-text

1. Install Yarn packages

yarn install

1. Run the development server, use the following commands from the root folder

For the web app

yarn run dev:start/web

For the server

yarn run dev:start/server

1. To run the mobile app follow the steps below

   1. Go to this page and follow the steps for both IOS and Android using the React Native CLI

   2. After setting up the development environment for mobile run the following commands from the root directory to start the app

      For the native IOS app

      yarn run dev:start/ios

      For the native Android app first open the Android simulator then run

      yarn run dev:start/android

Usage

• To be determined…

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Please read our [CONTRIBUTING][contributing] guidelines and our [Code of Conduct][code of conduct] before making contributions.

1. Fork the Project

2. Create your Feature Branch (git checkout -b feature/AmazingFeature)

3. Commit your Changes (git commit -m 'Add some AmazingFeature')

4. Push to the Branch (git push origin feature/AmazingFeature)

5. Read the information on here, then Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Radouane Khiri - @redvanisation - LinkedIn - redvanisation@gmail.com