jmularski / GraceReloaded

Grace Chatbot

Grace Chatbot, project designed to answer doctors questions about their patients using a chatbot app connected to neo4j database.

Technologies used

Prerequisites

Node.JS (last stable version) Docker (only if you want to use Docker way of running the project)

Dependencies

Project dependencies are managed using Lerna hoisting, to install dependencies run npm install.

Backend

Backend is developed using Express framework and Typescript. To start backend, fill the .example.env using your LUIS API key and production endpoint and your Neo4J database access data and rename it to .env file, then run npm run start:backend.

Frontend

Frontend is developed using HTML/CSS/JS and statically rendered using SSR. To start frontend run npm run start:frontend

Launching the project using Docker

To launch the project fill out the .example.env file using your LUIS API key and production endpoint and your Neo4J database access data and rename it to .env, then run make up.

Testing

A comprehensive suite of unit, integration and E2E tests is provided. To run backend unit and integration tests use command npm run test:backend

To run E2E tests follow the steps:

1. Install Cypress using npm install -g cypress
2. Install Cypress executables using cypress install
3. Start frontend and backend server
4. Run command npm run test:frontend.

Structure

• packages - contains project code:
  • backend - backend files
  • frontend - frontend files