Welcome to AcademiX! Where school management transforms from mundane to magical, utilizing the latest technologies to dance at your fingertips and light up the educational universe. We invite you on this whimsical journey where managing education is not just smart—it's enchanting! ✨
Imagine a world where school administration is a symphony of efficiency, communication flows seamlessly, and educational institutions rise to their highest potential. That's not just our dream—it's AcademiX reality! 🎶
- ✨ Centralized Data: The North Star guiding all operational processes.
- 📈 Automation: Think of it as your invisible assistant handling tiresome tasks like billing, so you can focus on creating stars.
- 📢 Improved Communication: Your magic wand for connecting everyone.
- 📏 Scalability: Grow and evolve with us, soaring on modern frameworks.
- 🖥️ Modern User Experience: It’s like piloting a sleek spaceship to galaxy education.
AcademiX isn't just software, it's a constellation of modules designed to sparkle throughout school administration. 🌌
Unravel the mysteries of each student from enrollment to graduation. 🌠
- 📜 Comprehensive Profiles
- 📝 Academic Tracking
- 📅 Attendance Monitoring
- 🏅 Service Enrollment
- 🚦 Behavioral Incidents Tracking
Turn the number-crunching into a rhythmic dance. 💸
- 💵 Automated Fee Management
- 💳 Flexible Payment Processing
- 🧾 Invoice & Receipt Generation
- 📆 Payment Plans & Reminders
- 📊 Financial Reporting
Channel energy into extracurricular activities and services. 🎨
- 🛠️ Customizable Service Offerings
- 🔄 Enrollment & Capacity Tracking
- 🔗 Automated Billing Integration
- 📈 Usage Analytics
Weave strong familial bonds and enable comprehensive engagement. 🧑🤝🧑
- 🌳 Family Tree Visualization
- 🧑💻 Guardian Portals
- 🚨 Emergency Contacts
- 📧 Communication Hub
Equip educators with the tools to thrive and spread educational brilliance. 🏆
- 📔 Detailed Profiles
- 📖 Class & Course Assignment
- 📊 Performance & Evaluation
- 📅 Schedule Management
- 📝 Exam & Grading Tools
Embarking on your AcademiX journey is as simple as 1-2-3! 🛸
Ensure you have:
- 🛠️ Node.js v18+
- 📚 npm or yarn
- 🗄️ PostgreSQL server
cd backend
npm install # or yarn install
cp .env.example .env
npm run prisma:generate # or yarn prisma:generate
npm run prisma:migrate dev # or yarn prisma:migrate dev
npm run start:dev # or yarn start:devcd frontend
npm install # or yarn install
cp .env.example .env
npm run dev # or yarn devDeep dive into .env files and unlock AcademiX's full potential. 🚪
NODE_ENV=development # Change to production when ready
PORT=3000
DATABASE_URL=<YOUR-POSTGRES-STRING>
JWT_SECRET=<YOUR-SECRET>NODE_ENV=development # Change to production when ready
VITE_API_URL="http://localhost:3000/api"
VITE_SUPABASE_URL=<YOUR-SUPABASE-URL>
VITE_SUPABASE_ANON_KEY=<YOUR-SUPABASE-ANON-KEY>Unveil the intricate design at the heart of AcademiX! 🧬
- Students, Teachers, Guardians
- Courses, Classes
- Services, Fees
- Users & Roles
(A link to an interactive schema diagram appears here for mystical insight.)
Guard the treasures within AcademiX with robust security spells:
- 🔒 JWT Authentication
- 📜 RBAC
- 🔩 Password Hashing
- 🔍 Input Validation
- 🌐 CORS Protection
- ⏲️ Rate Limiting
Onward to scaling new heights with swift deployment techniques. 🌐
- Build production server:
cd backend npm run build # or yarn build
- Configure
.envfor production. - Start server with PM2 or cloud deployment:
npm run start:prod # or yarn start:prod
- Build production frontend:
cd frontend npm run build # or yarn build
- Deploy
distfolder using Netlify, Vercel, etc.
Join the grand collaboration quest to expand AcademiX’s universe! 🧙♂️
- Fork the project
- Clone on your machine
- Branch for your feature/fix
- Commit your creations
- Push and Open Pull Request
Check our CONTRIBUTING.md for more details.
- Hamza Hadioui - Visionary Initiator - See GitHub Journey
To all open-source champions who laid the foundation, AcademiX rises high with your support and inspiration. 🚀
Welcome aboard AcademiX—where management meets magic and education dreams soar! 🌠