Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.02 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.02 KB
Raw

ExplainAI

This is a monorepo composed of three packages.

  • Web (Front End)
  • API (Back End)
  • Database

Quick Start

To run the application, you will need to open 3 terminal instances and run each of these steps in a separate terminal.

Terminal 1. Launch the database

The database runs inside a Docker container.

  1. You will need to install Docker
  2. Ensure it is running on your computer to run the database.
  3. Run the following commands
cd database
npm run start

Terminal 2. Launch the API

  1. Inside the /api directory, duplicate the .env.example file and rename the copy to .env.
  2. Run these commands
cd api
npm install
npm run start

Terminal 3. Launch the Web App

  1. Run these commands
cd web
npm install
npm run start

Confirm Working

If you visit http://localhost:3000 in your browser, you should see a blob of JSON that is being fetched from the database, via the api, and rendered on the front end. 👍