Matrix_Calculator

An AI-powered matrix calculator web application that provides instant solutions for matrix operations, complete with step-by-step explanations. Built with React, Vite, and powered by Google's Generative AI.

---

🔗 Links

• Issues
• Contributing
• Security Policy
• Code of Conduct

---

📑 Table of Contents

• Installation
• Usage
• Features
• Folder Structure
• Contributing
• License
• Security
• Code of Conduct
• Tech Stack
• Dependencies

---

🚀 Installation

Prerequisites

• Node.js (v18 or higher recommended)
• npm or yarn
• Google Generative AI API Key (for backend)

Setup Steps

1. Clone the repository:

   git clone https://github.com/H0NEYP0T-466/Matrix_Calculator.git
   cd Matrix_Calculator

2. Install frontend dependencies:

   npm install

3. Install backend dependencies:

   cd backend
   npm install

4. Configure environment variables:

   Create a .env file in the backend directory with your API key:

   GEMINI_API_KEY=your_google_genai_api_key

5. Start the backend server:

   cd backend
   npm start

6. Start the frontend development server:

   # From the root directory
   npm run dev

7. Open the app:

   Navigate to http://localhost:5173 in your browser.

---

⚡ Usage

1. Launch the application by following the installation steps above.
2. Enter your matrix values in the input fields.
3. Select an operation (addition, subtraction, multiplication, determinant, inverse, transpose, etc.).
4. Click "Calculate Now!" to get instant results.
5. View step-by-step explanations powered by AI.

---

✨ Features

• Matrix Operations – Addition, subtraction, multiplication, and more
• AI Explanations – Get detailed explanations powered by Google's Generative AI
• Step-by-Step Solutions – Understand how the calculation was performed
• Modern UI – Smooth animations with GSAP
• Math Rendering – Beautiful mathematical notation with KaTeX
• Responsive Design – Works on desktop and mobile devices

---

📂 Folder Structure

Matrix_Calculator/
├── backend/
│   ├── controller/
│   │   └── controller.js
│   ├── model/
│   │   └── ai_model.js
│   ├── index.js
│   ├── package.json
│   └── package-lock.json
├── public/
├── Router/
│   └── Router.jsx
├── src/
│   ├── assets/
│   ├── components/
│   │   ├── Nav_bar.jsx
│   │   ├── Nav_bar.css
│   │   ├── Page.jsx
│   │   ├── Page.css
│   │   ├── Reveiw_page.jsx
│   │   └── Reveiw_Page.css
│   ├── App.jsx
│   ├── App.css
│   ├── main.jsx
│   └── index.css
├── index.html
├── package.json
├── package-lock.json
├── vite.config.js
├── eslint.config.js
├── .gitignore
├── README.md
├── LICENSE
├── CONTRIBUTING.md
├── SECURITY.md
└── CODE_OF_CONDUCT.md

---

🤝 Contributing

Contributions are welcome! Please read the Contributing Guidelines for details on how to submit pull requests, report bugs, and suggest features.

---

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

🛡 Security

For reporting security vulnerabilities, please read our Security Policy.

---

📏 Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming and inclusive community.

---

🛠 Tech Stack

Languages

Frameworks & Libraries

DevOps / CI / Tools

Cloud / AI Services

---

📦 Dependencies & Packages

Frontend - Runtime Dependencies

– Promise based HTTP client for the browser and Node.js

– Professional-grade animation library

– A JavaScript library for building user interfaces

– React package for working with the DOM

– Render Markdown as React components

– Declarative routing for React

– DOM bindings for React Router

– Rehype plugin to render math with KaTeX

– Remark plugin to support math

Frontend - Dev Dependencies

– ESLint JavaScript plugin

– TypeScript definitions for React

– TypeScript definitions for React DOM

– Official React plugin for Vite

– Pluggable JavaScript linter

– ESLint rules for React Hooks

– Validate React Refresh

– Global identifiers from different JavaScript environments

– Next generation frontend tooling

Backend - Runtime Dependencies

– Google Generative AI SDK

– Node.js CORS middleware

– Loads environment variables from .env file

– Fast, unopinionated web framework for Node.js

---

Made with ❤ by H0NEYP0T-466