Amrikyy AI OS is a full-stack application that provides a web-based operating system with AI-powered features. It's built with React, Vite, and TypeScript on the frontend, and Node.js with Express on the backend.
- Web-based OS: A familiar desktop-like interface in your browser.
- AI-Powered Agents: A suite of specialized AI agents for various tasks, including travel planning, content creation, and more.
- Extensible: The agent-based architecture allows for easy expansion and addition of new functionalities.
- Google Gemini Integration: Leverages the power of Google's Gemini models for advanced AI capabilities.
- Full-Stack: A complete solution with both frontend and backend components.
- Node.js (v18 or higher)
- npm
- A Google Gemini API key
-
Clone the repository:
git clone https://github.com/Moeabdelaziz007/Amrikyy-AI-OS.git cd Amrikyy-AI-OS -
Install dependencies:
npm install
-
Set up environment variables:
- Create a
.envfile in thebackenddirectory by copying the.env.examplefile. - Add your Google Gemini API key and any other required API keys to the
.envfile.
- Create a
-
Start the backend server:
npm run start-backend
-
Start the frontend development server:
npm run dev
The application will be available at http://localhost:5173.
To use Kombai for frontend development and design-to-code workflow, see the comprehensive setup guide:
- Kombai Setup Guide - Complete instructions for setting up Kombai with shell integration, troubleshooting preview issues, and IDE configuration.
-
Run all tests:
npm test -
Run frontend tests:
npm run test:frontend
-
Run backend tests:
npm run test:backend
-
Run end-to-end tests:
npm run test:e2e
Contributions are welcome! Please feel free to submit a pull request or open an issue.
This project is licensed under the MIT License. See the LICENSE file for details.