Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 2.32 KB

README.md

File metadata and controls

79 lines (58 loc) · 2.32 KB
Raw

RODE Solver

This is a math solver application for Ordinary Differential Equation integrated by Gemini Api

It's Interface kind of like Chatgpt, you can ask the question and it will solve it for you.

How to start locally

Required tools

Steps

  1. Clone the repository

    git clone https://github.com/shu-vro/RODE-Solver.git
cd RODE-Solver

  2. Install the dependencies

    bun i

  3. Head to Google Ai Studio and grab your API key. The model used in this project is: gemini-1.5-flash

  4. Head to Firebase and create a new project. Then grab the following keys from the project settings by creating a web app

    • Web API Key
    • Auth Domain
    • Project Id
    • Storage Bucket
    • Messaging Sender Id
    • App Id

  5. Create a .env file in the root directory and add the following

    GEMINI_API_KEY=<your key here>
NEXT_PUBLIC_FIREBASE_API_KEY=<your key here>
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=<your key here>
NEXT_PUBLIC_FIREBASE_PROJECT_ID=<your key here>
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=<your key here>
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=<your key here>
NEXT_PUBLIC_FIREBASE_APP_ID=<your key here>

  6. Run the app

    bun run dev

Documentation

Contributing

Please head to CONTRIBUTING.md to know more about contributing to this project.

I hosted my code to vercel, you can host it to any platform you prefer.

Constrains

Please head to https://ai.google.dev/pricing for knowing more about the constrains of the free API.

TODO

  • theming for mobile
  • Up and down arrow for navigation
  • login system
  • save the question
  • three different modes
    • backend
    • frontend
  • equation from url
  • Other's solutions
  • Sidebar styling for mobile view (rounded corner, margin on left, colored border)
  • PWA Button placement
  • Miscellaneous