https://github.com/duquejo/ia-backendnode

IA backend NodeJS project using Serverless, Webpack + Typescript and Tesseract OCR
https://github.com/duquejo/ia-backendnode

Last synced: over 1 year ago
JSON representation

IA backend NodeJS project using Serverless, Webpack + Typescript and Tesseract OCR

• Host: GitHub
• URL: https://github.com/duquejo/ia-backendnode
• Owner: duquejo
• Created: 2022-09-10T16:07:46.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T01:36:28.000Z (over 1 year ago)
• Last Synced: 2025-01-22T21:16:01.788Z (over 1 year ago)
• Language: TypeScript
• Size: 53.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# IA OCR Service backend

_Link to [Frontend repository URL](https://github.com/duquejo/IA-Project-Frontend)_

[![node](https://img.shields.io/badge/node-v16.3.X-yellow.svg)](https://nodejs.org)

[![npm](https://img.shields.io/badge/npm-v8.3.X-red.svg)](https://www.npmjs.com/)

[![Serverless](https://img.shields.io/badge/serverless-v3.22.0-orange.svg)](https://www.serverless.com/)

[![Webpack](https://img.shields.io/badge/webpack-v5.74.0-green.svg)](https://webpack.js.org/)

[![Tesseract](https://img.shields.io/badge/tesseract-v3.0.2-white.svg)](https://tesseract.projectnaptha.com/)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=duquejo01_IA-BackendNode&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=duquejo01_IA-BackendNode)

## Prerequisites

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

* [Git](http://git-scm.com/)

* [Node](https://nodejs.org)

* [NPM](https://www.npmjs.com/)

## Installation

* `git clone git@github.com: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](https://jestjs.io/).

## Getting unit test coverage

Run `npm run test:coverage` to execute the unit tests coverage via [Jest](https://jestjs.io/).

## 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 :beer: you deserve it.