🚀 Res-AI Hub

Empowering AI Innovation on ResilientDB

Live Demo • Documentation • Report Bug • Request Feature

📖 About

Res-AI Hub is the central platform for exploring and accessing AI-powered tools built on the ResilientDB ecosystem. It provides an intuitive interface to discover, learn about, and access various AI tools including Nexus, Beacon, and ContractForge.

🎯 What is Res-AI?

Res-AI unlocks next-generation AI capabilities on ResilientDB, enabling users to:

• Explore consensus protocols and research papers with AI assistance
• Interact with documentation through intelligent Q&A systems
• Develop smart contracts with AI-powered suggestions
• Discover the innovations behind our high-performance blockchain database

🛠️ Our Tools

🔮 Nexus

Your intelligent gateway to ResilientDB's world. Explore consensus protocols, dive into research papers, and discover the innovations behind our database.

📚 Beacon

Explore your documentation like never before — ask questions, dive deep, and connect directly to the underlying code.

⚒️ ContractForge

Forge smart contracts with AI assistance. Design, deploy, and manage blockchain contracts with intelligent suggestions and automated testing.

🚀 Getting Started

Prerequisites

• Node.js (v18 or higher)
• npm or yarn
• Git

Installation

1. Clone the repository

   git clone https://github.com/Bismanpal-Singh/Res-AI.git
   cd Res-AI

2. Install dependencies

   npm install
   # or
   yarn install

3. Start the development server

   npm run dev
   # or
   yarn dev

4. Open your browser Navigate to http://localhost:5173 to see the application.

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run lint - Run ESLint

🏗️ Tech Stack

• Frontend Framework: React 19.0.0
• Language: TypeScript 5.7.2
• Build Tool: Vite 6.3.1
• Styling: Tailwind CSS
• Animations: Framer Motion, Lottie React
• UI Components: Custom components with shadcn/ui
• Routing: React Router DOM
• Icons: Lucide React, Tabler Icons

🎨 Features

• ✨ Modern UI/UX with smooth animations and responsive design
• 🎭 Interactive Carousel showcasing our AI tools
• 📱 Mobile-First responsive design
• 🌙 Dark Theme with beautiful gradients
• ⚡ Fast Performance with Vite and optimized assets
• 🎯 Accessibility focused design
• 🔗 Seamless Integration with ResilientDB ecosystem

🤝 Contributing

We welcome contributions from the community! This project is participating in Hacktoberfest 2025.

How to Contribute

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Make your changes
4. Commit your changes

   git commit -m 'Add some amazing feature'

5. Push to the branch

   git push origin feature/amazing-feature

6. Open a Pull Request

Contribution Areas

• 🎨 UI/UX Improvements - Enhance the user interface and experience
• ♿ Accessibility - Make the platform more accessible
• 📱 Mobile Experience - Improve mobile and touch interactions
• ⚡ Quick Wins - Small improvements and bug fixes
• 🧪 Testing - Add tests and improve code quality
• 📚 Documentation - Improve documentation and guides

Issue Labels

• good first issue - Perfect for first-time contributors
• help wanted - Community help needed
• enhancement - New features and improvements
• bug - Bug fixes
• documentation - Documentation improvements
• ui/ux - Design-related issues
• mobile - Mobile-specific improvements

📁 Project Structure

src/
├── components/          # Reusable UI components
│   ├── ui/             # Base UI components
│   ├── NavBar.tsx      # Navigation component
│   ├── Hero.tsx        # Hero section
│   └── footer.tsx      # Footer component
├── pages/              # Page components
│   ├── Home.tsx        # Home page
│   ├── ToolsPage.tsx   # Tools showcase
│   └── LandingPage.tsx # Landing page
├── assets/             # Static assets
│   └── *.json          # Lottie animation files
├── lib/                # Utility functions
└── App.tsx             # Main app component

🌟 Hacktoberfest 2025

This project is participating in Hacktoberfest! We have several contribution opportunities:

• Beginner-friendly issues for first-time contributors
• UI/UX enhancements for design enthusiasts
• Mobile improvements for mobile developers
• Quick wins for quick contributions
• Accessibility improvements for inclusive design

Check out our issue templates for detailed contribution guidelines.

📄 License

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

🙏 Acknowledgments

• ExpoLab at UC Davis for the amazing research and development
• ResilientDB community for the incredible blockchain database
• Contributors who help make this project better
• Hacktoberfest for encouraging open source contributions

📞 Contact

• LinkedIn: bismanpal-anand
• ResilientDB: https://resilientdb.apache.org/
• ExpoLab: https://expolab.resilientdb.com/

---

Made with ❤️ by the ExpoLab team at UC Davis

⭐ Star this repo • 🐛 Report Bug • 💡 Request Feature