Skip to content

Fatima-FSSE/rootranger

Repository files navigation

RootRanger 🌱

RootRanger is an innovative application designed to help users grow their own indoor and outdoor plants, leveraging the power of the Google Gemini AI API. Whether you're a beginner or an experienced gardener, RootRanger provides personalized, real-time advice to guide you through every step of your plant's growth journey.

Table of Contents

Features

  • Google Gemini AI Integration: Get expert advice on plant care and maintenance, customized to your needs.
  • User Authentication: Secure login and registration using Firebase Authentication.
  • Conversation History: All your interactions and advice are stored securely in the Firebase database, allowing easy access to past conversations.
  • Responsive Design: Developed with Next.js and Bootstrap, ensuring a seamless experience across all devices.
  • Deployment on Vercel: Fast, scalable, and reliable deployment for global accessibility.
  • Upcoming Feature - RAG (Retrieval-Augmented Generation): Future enhancements to provide even more accurate and tailored information.

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js: Make sure you have Node.js installed on your machine.
  • Firebase Account: You'll need a Firebase account for authentication and database services.
  • Google Gemini API Access: Ensure you have access to the Google Gemini API.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/rootranger.git
    cd rootranger
  2. Install dependencies:

    npm install
  3. Set up Firebase:

    • Create a new Firebase project.

    • Set up Authentication and Firestore Database in your Firebase console.

    • Create a .env.local file in the root directory and add your Firebase configuration:

      NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
      NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
      NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
      NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
      NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
      NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
  4. Run the development server:

    npm run dev

    Open http://localhost:3000 to view the app in your browser.

Usage

  • Sign Up / Sign In: Users can sign up and sign in using Firebase Authentication.
  • Start a Conversation: Interact with the AI chatbot to receive personalized plant care advice.
  • View Conversation History: Access past conversations stored in the Firebase database.

Technologies Used

  • Next.js: React framework for server-side rendering and static site generation.
  • Bootstrap: Front-end component library for responsive design.
  • Firebase: Backend-as-a-Service for authentication, real-time database, and hosting.
  • Google Gemini AI API: Provides AI-driven plant care advice.
  • Vercel: Deployment platform for fast and scalable hosting.

Team Members

  • [Fatima Riaz]
  • [Descartes Tuyishime]
  • [Ahmed Handulle]