VICKY is an Artificial Intelligence personal assistant aimed at improving mental health and professional development. This project is built using Next.js 13, Redux for state management, Chakra UI for React components, and Tailwind CSS for utility CSS classes. It also utilizes the OpenAI Chat Completion API for generating prompts.
Before running the project, make sure you have the following environment variables set:
OPEN_AI_API_KEY
: Your OpenAI API key for accessing the Chat Completion API.NEXTAUTH_SECRET
: Secret key for NextAuth authentication.NEXT_PUBLIC_SPEECHLY_APP_ID
: Speechly app ID for voice input .GOOGLE_CLIENT_ID
and GOOGLE_CLIENT_SECRET
: Google OAuth client ID and secret for authentication .To run the VICKY project locally, follow these steps:
Clone the repository:
git clone https://github.com/Paul-Okello/GPT-chatbot.git
Navigate to the project directory:
cd vicky-project
Install dependencies:
npm install
Set up the required environment variables by creating a .env
file in the root directory of the project and adding the necessary values:
OPEN_AI_API_KEY=<your-openai-api-key>
NEXTAUTH_SECRET=<your-nextauth-secret>
NEXT_PUBLIC_SPEECHLY_APP_ID=<your-speechly-app-id>
GOOGLE_CLIENT_ID=<your-google-client-id>
GOOGLE_CLIENT_SECRET=<your-google-client-secret>
Start the development server:
npm run dev
Open your web browser and access the project at http://localhost:3000
.
Once the project is running, you can interact with VICKY through the chat interface. You can ask questions, seek advice, or have general conversations to improve your mental health and professional development.
VICKY will provide responses based on the AI models and prompts used in the project. Feel free to experiment and explore different topics and prompts to get personalized assistance.
We welcome any feedback or contributions to enhance the VICKY project. If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.
We hope that VICKY will be a helpful companion on your journey towards improved mental health and professional growth.
This project is licensed under the MIT License.