Skip to content

README.md

Latest commit

 

History

History
51 lines (38 loc) · 1.77 KB

README.md

File metadata and controls

51 lines (38 loc) · 1.77 KB

BeaverAI

Description

This is an AI-powered chatbot designed to assist UACH (Universidad Autónoma de Chihuahua) students and staff. The chatbot provides information and answers questions. Without doing the students' work, but rather serving as a guide to help them complete their assignments, projects, or answer their questions.

Features

  • Natural language processing capabilities
  • Quick responses to common university-related questions
  • User-friendly interface
  • 24/7 availability

Installation

  1. Clone the repository
  2. Execute npm install to install the required dependencies
  3. Run npm run dev to start the development server

Use Gemini API

  1. Go to the Google AI Studio
  2. Create a new project
  3. Get the API key
  4. Add the API key to the .env file or use the API input in the chatbot interface

Project Structure

  • public/: Contains static assets like favicon and images.
  • src/
    • assets/: Images and icons used in the project.
    • components/: Astro components such as Header, Footer, Chat, and Welcome.
    • layouts/: Layout components, including the main Layout.astro.
    • pages/: Astro pages including the main index page.
    • scripts/: JavaScript files for chat functionality.
    • styles/: Global CSS styles.

Technologies Used

  • Astro: Static site generator.
  • Tailwind CSS: Utility-first CSS framework.
  • JavaScript: For chat interaction logic.

Features

  • Responsive design for mobile and desktop.
  • Custom font integration using Tailwind CSS configuration.
  • Chat interface with dynamic message handling.
  • Favicon and branding.

Customization

  • Fonts are configured in tailwind.config.cjs and imported in global styles.
  • Colors and gradients are applied using Tailwind CSS utility classes.