QuestionDemo-API

The QuestionDemo-API is the API interface used for the QuestionDemo React application. The application itself is written in native Node.js using Express. The back end is a PostgreSQL database running through Sequelize.

Setting Up The Database

The database will automatically populate itself. All you need to provide is a blank database along with usable credentials :)

Once you have cloned the repository and created a blank databases. Most likely using pgAdmin. You will need to modify the "config/config.json" file to match the credentials you have just assigned to the database.

{
  "development": {
    "username": "YourUserName",
    "password": "YourPassword",
    "database": "YourDatabase",
    "host": "localhost",
    "dialect": "postgres",
    "operatorsAliases": false
  }
}

Once this is done you will need to run two commands to build out the datbase structure and populate the example data. The example database comes with 12 Question Groups and 32400 Example Questions.

First you need to build out the structure and install the FuzyyMatch PostgreSQL library

node buildDatabase.js

Next use Sequelize to populate the database

npx sequelize-cli db:seed:all

Running The API

At this point you should be able to npm start.

To verify that the API is online and functional you can import the "Question Example.postman_collection.json" file into Postman. It will default to localhost:3030 and should run out of the box.