OPEN AI Based Basic Question Answer service

Technologies used

1. Node JS
2. TypeScript
3. KOA
4. TypeORM
5. Open AI

Steps to run the project

1. Install node, npm and postgres
2. Create an empty db
3. Update app-data-source.ts with the db details. Since an ORM has been used the tables will be created on its own.
4. This project uses Open AI so an Open AI API Key is required. As of writing this, Open AI has discontinued its paid service as a minimun wallet load of 5 USD is required to use its APIs. Set this key in .env.
5. In the env file we can also opt for different models and temperature
6. Since it is a TypeScript project we need to compile it first so run tsc
7. Now we run npm run server to start the service
8. Postman Collection for the APIs are provided in the repo.

Future Improvements

1. Integrate a testing framework like Mocha/Chai
2. Dockerize the service
3. Integrate apidocs
4. Include validation of API calls from FE
5. Improve error handling