Octopi Frontend

📌 Project Description

Octopi Frontend is the user interface for the Octopi software development effort prediction tool. It provides a modern, interactive dashboard for users to input project metrics and visualize the predicted effort required.

The application interacts with the Octopi ML API to fetch predictions generated by a machine learning model trained on a large dataset of software projects.

🔗 Backend Repository: Octopi ML API

🛠️ Technologies Used

This project is built with:

Core & Styling

• React: The library for web and native user interfaces.
• Vite: Next Generation Frontend Tooling.
• Tailwind CSS: A utility-first CSS framework.
• Shadcn UI: Beautifully designed components built with Radix UI and Tailwind CSS.
• Framer Motion: A production-ready motion library for React.

Components & State Management

• React Query: Powerful asynchronous state management.
• React Hook Form: Performant, flexible and extensible forms with easy validation.
• Zod: TypeScript-first schema declaration and validation library.
• Recharts: A composable charting library built on React components.
• Lucide React: Beautiful & consistent icons.

📦 Installation

1. Clone the repository:

   git clone https://github.com/seif-a096/Octopi.git
   cd Octopi

2. Install dependencies:

   npm install
   # or
   bun install

3. Run the development server:

   npm run dev
   # or
   bun run dev

📄 License

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