LAEP LLM

Description

This project is a part of California Polytechnic State University (Cal Poly) in San Luis Obispo under the supervision of Prof. Franz J. Kurfess. It is an open-source repository intended to aid students in their senior project.

We are currently in the early stages of building an AI chatbot that will provide ethical considerations for senior projects, help match students with advisors for their projects, and utilize the power of AI to enhance the experience of a student's senior project.

Table of Contents

• Requirements
• Installation
• Usage
• Next Steps
• Contributors
• License

Requirements

• Node JS
• npm
• Create Open AI account

Installation

1. Clone the repository

   git clone https://github.com/Castro19/LAEP-GPT.git
   

2. Install client & server dependencies In the root directory LAEP-GPT enter the following:

   npm run install:all
   

3. Install Dependencies for root directory In the root directory LAEP-GPT enter the following:

   npm install
   

4. Configure Firebase:

• Go to your firebase console

  • Click add project
  • Follow their guidelines

• Once you create your project, a config file should be ready for you.

  • In your newly created Firebase project, click on the left sidebar for the option of Project Settings.
  • Scroll down until you are at the Your Apps section where you will Add app
  • Select the web with </> symbols. Click
  • Here you should get the SDK setup and configuration
  • Copy your firebaseConfig options.

• Now that you have your firebase configuration file, go into the client/sample.env and update the changes here.

• Finally rename sample.env to be .env

5. Get your Open AI API key from Open AI API Key:

   • Go into the server/sample.env file and set the variable OPENAI_API_KEY to the OpenAI key.

6. Configure MongoDB Compass:

• Make sure MongoDB is setup on your local machine

• Go into the server/sample.env file and set the variable ATLAS_URI to the URI for your MongoDB database.

• Finally rename sample.env to be .env

Usage

1. Start the client and server concurrently

   npm start
   

License

To be updated.