This project is a collection of serverless microservices built with NestJS, designed to run on AWS Lambda. It includes three services: bite-bot, doc-brew, and help-hopper, each responsible for interacting with OpenAI's API and providing distinct functionalities.
- bite-bot: A service tailored for quick, bite-sized interactions with OpenAI's API.
- doc-brew: This service focuses on generating and processing documents using OpenAI's API.
- help-hopper: Aimed at providing help and guidance through OpenAI's API.
Each service is encapsulated in its own Lambda function, with a shared common module to handle requests to OpenAI's API.
These instructions will get your copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
- Node.js (version 14.x or later)
- AWS CLI (configured with appropriate permissions)
- Serverless Framework
- An OpenAI API key
-
Clone the repository:
git clone https://github.com/your-username/your-repo-name.git
-
Install dependencies
cd your-repo-name npm install -
Set up environment variables:
Create a .env file in the root of your project and add your OpenAI API key:
OPENAI_API_KEY=your_openai_api_key_here
Run Serverless Offline for local development:
npm run slsDeploy your project to AWS with the following command:
serverless deploy