Contribute on GitHub
Welcome college students and open-source enthusiasts! Akshay AI Tools is an open ecosystem built to democratize artificial intelligence for education and productivity. Here is everything you need to know to make your first meaningful pull request.
Why the Project Exists
Most state-of-the-art AI tools are fragmented across dozens of paid subscriptions and confusing interfaces. Akshay AI Tools unifies 25+ specialized AI engines into one completely free, high-performance workspace designed specifically for college students, software engineers, and creators.
Verified Tech Stack
The repository uses a zero-bloat, production-ready static architecture:
- Frontend: HTML5 Semantic Markup, Vanilla CSS3 (Custom Design System), JavaScript (ES6+ Modules)
- Backend & DB: InsForge Backend-as-a-Service (PostgreSQL, PostgREST API)
- AI Architecture: InsForge Serverless Edge Proxy (
ai-proxy.js) routing to OpenRouter & Google Gemini - Client Libraries: PDF.js (in-browser PDF extraction), PptxGenJS (PowerPoint export), Web Speech API
How to Install & Run the Project
Follow these 4 simple steps to run the complete website on your local machine.
Fork and Clone the Repository
First fork the project on GitHub, then clone your fork to your computer:
cd akshay-website
Install Dependencies
Install the required SDK and CLI packages with npm:
Start the Local Development Server
Run the built-in static web server:
Open http://localhost:3000 in your browser to view the live website.
Create a Feature Branch
Always work on a clean, descriptive branch before modifying files:
Ways You Can Participate
1. Add New Tool Prompts & Presets
Add tailored student templates to tools-data.js (e.g. GRE/GATE preparation prompts, LeetCode debugging templates, or academic paper outline schemas).
2. Improve Accessibility & Themes
Help refine ARIA landmark labels, improve mobile breakpoint spacing, optimize touch targets for mobile phones, and audit contrast ratios.
3. Fix Bugs & Report Issues
Encountered an edge case in speech recognition or PDF extraction? Open a detailed GitHub Issue with reproducible steps or submit a pull request with the fix.
Pull Request (PR) Checklist
Before submitting your pull request to main, please review this quality checklist:
- ✅ Zero Secret Exposure: Never commit API keys, personal tokens, or backend credentials. All server keys stay safely in the InsForge vault.
- ✅ Test Changed Functionality: Open the modified pages in your browser and verify in DevTools Console that there are zero JavaScript errors.
- ✅ Preserve Architecture: Do not introduce bulky external front-end frameworks unless discussed; maintain the fast Vanilla HTML/CSS/JS baseline.
- ✅ Clear Commit Messages: Follow conventional commits (e.g.,
feat: add notes quiz generator for studentsorfix: repair speech synthesis audio pause). - ✅ No Placeholder Buttons: Every button or link introduced must be genuinely functional or clearly explain its requirement.