README.md

Natural-Language-Text-Analyzer

This is a web app that uses Aylien API to analyze text and provide feedback.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• Node and npm manager
• Aylien API developer account

You need node and npm installed on your system to be able to run and build this project.

Installation

In order to install and run this project follow the below steps

• Go to Aylien Website and register as a developer for free.
• Go to Node Website and install node server / npm manager on your system.
• Fork or clone this repository and download it to your system.
• Go to downloaded repository and create a file named ".env".
• Edit ".env" with your appID and apiKey optained from Aylien Website in the following format

API_ID=**************************
API_KEY=**************************

• Run following command on terminal/cmd/shell in the project folder

npm install

Run project in production mode

To start the webpack dev server at port 8080

  npm run build-dev

Run project in production mode

Generate the dist files and then start server at port 3000

  npm run build-prod
  npm start

Testing

Testing is done with Jest. To run test, use the command

  npm run test

Built With

• HTML5 - Front-end markup language
• SASS - Front-end styling language
• javascript - Front-end code bundler
• Bootstrap 4 - Front-end styleing library
• Webpack - Front-end built tool
• Express - NodeJS Back-end server

Deployed on

• Heroku at Text Analyzer

Authors

• Farhan Kiyani