IA OCR Service backend

Link to Frontend repository URL

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node
• NPM

Installation

• git clone [email protected]:duquejo01/IA-BackendNode.git this repository
• change into the new directory cd IA-BackendNode

Dependencies

Run npm install to install project dependencies.

Build

Run npm run build to build the project. The build artifact (a .zip file containing your package and its dependencies) will be stored in the dist/ directory.

Local development

Run npm start for local development orchestration using Serverless framework and Webpack. Also you can run it though http://localhost:8000/recognize POST endpoint.

Running unit tests

Run npm test to execute the unit tests via Jest.

Getting unit test coverage

Run npm run test:coverage to execute the unit tests coverage via Jest.

Contributing

If you find this repo useful here's how you can help:

1. Send a Merge Request with your awesome new features and bug fixes
2. Wait for a Coronita 🍺 you deserve it.