DJilanov/React-N-Gram

Simple word n-gram checking app utilizing NodeJS and React

Application

Sample project based on ReactJS

Table of contents

• Application
  • Table of contents
  • Stack
  • Setup
    • Clone the repository
    • Build and run
  • API
  • Contact
  • License

Stack

• React front end
• NGINX
• Docker

Setup

Clone the repository

Clone the repository to your filesystem

$ git clone https://github.com/DJilanov/React-N-Gram.git
$ cd React-N-Gram

Build and run

Build images

$ docker-compose build

Run containers

$ docker-compose up

Stop containers

$ docker-compose down

API

The API documentation is available here.

Contact

Dimitar Jilanov

License

Copyright (c) Dimitar Jilanov.

Licensed under the MIT License.

TODO:

1. Write FE tests
2. Finish BE tests
3. Add all already calculated sentenses to DB so we dont do calculations when we can just fetch precalculated data ( can use bigQuerry )