🌋 VulcanoConnects - Documentation
Welcome to the VulcanoConnects documentation hub! This repository contains all public documentation for contributors, designers, and developers.
Note: This is a documentation-only repository. The source code is maintained in a private repository.
🎯 Quick Links
🎨 For Designers
- Theme System Overview - Understanding the theme architecture
- Designer Schema - Complete theme token reference for design handoff
- Color System - Brand colors, states, and usage guidelines
💻 For Developers
- Developer Guide - How to use theme tokens in code
- Migration Status - Current implementation progress
- Contributing Guidelines - How to contribute
🔒 Security
- Security Overview - Security practices and reporting
📚 About VulcanoConnects
VulcanoConnects is a modern web platform built with:
- Next.js 16 with App Router
- React 19 with Server Components
- TypeScript 5 for type safety
- Tailwind CSS v4 with custom theme system
- Prisma ORM with SQLite
- NextAuth.js for authentication
Key Features
- 🎨 Comprehensive Theme System - 70+ design tokens for light/dark modes
- 🌍 Internationalization - Multi-language support (EN, IT, FR, DE)
- 🔐 Secure Authentication - Email verification, password reset
- 📱 Responsive Design - Mobile-first approach
- ♿ Accessibility - WCAG 2.1 compliant
🤝 Contributing
We welcome contributions! Please read our Contributing Guidelines to get started.
Ways to Contribute
- 🎨 Design feedback and theme improvements
- 📝 Documentation improvements
- 🐛 Bug reports and feature requests
- 🌍 Translations and localization
📖 Documentation Structure
docs/
├── theme/ # Theme system documentation
│ ├── README.md # Theme overview
│ ├── designer-schema.md # Complete token reference
│ ├── developer-guide.md # Usage guide for developers
│ └── migration-status.md # Implementation tracking
├── contributing/ # Contribution guidelines
│ └── README.md
└── security/ # Security documentation
└── README.md
📄 License
This documentation is licensed under MIT License.
The VulcanoConnects platform source code is proprietary.
📞 Contact & Support
- Documentation Issues: Open an issue in this repository
- Feature Requests: Contact the maintainers
- Security Reports: See Security Policy
Made with ❤️ by the VulcanoConnects Team