A comprehensive scholarship management system that connects students, coordinators, and administrators in a seamless platform for managing scholarship applications, reviews, and payments.
- 📝 Application Management: Submit and track scholarship applications
- 🎯 Available Scholarships: Browse and filter available scholarship opportunities
- 📊 Dashboard: View application status, payments, and statistics
- 📁 Document Upload: Upload required documents for applications
- 💰 Payment Tracking: Monitor scholarship payments and history
- 🔔 Notifications: Real-time updates on application status
- 👤 Profile Management: Update personal and academic information
- 📋 Application Review: Review and evaluate student applications
- 📈 Reports & Analytics: Generate comprehensive reports
- 👥 Student Management: Manage student profiles and information
- 🏆 Scholarship Management: Oversee scholarship programs
- 📊 Committee Reviews: Coordinate review processes
- 👥 User Management: Manage all system users
- 🏢 Provider Management: Manage scholarship providers
- ⚙️ System Settings: Configure system parameters
- 💳 Payment Administration: Oversee payment processes
- 📊 System Analytics: Comprehensive system overview
- 🚀 Node.js - Runtime environment
- ⚡ Express.js - Web framework
- 🗄️ MySQL - Database
- 🔧 Prisma - ORM and database toolkit
- 🔐 JWT - Authentication
- 🔒 bcryptjs - Password hashing
- 📁 Multer - File upload handling
- ⚛️ React.js - UI library
- 🛣️ React Router - Client-side routing
- 🎨 CSS3 - Styling
- 📱 Responsive Design - Mobile-friendly interface
- 🐳 Docker - Containerization
- 📦 Docker Compose - Multi-container orchestration
Before running this application, make sure you have the following installed:
- Node.js (v16 or higher)
- npm or yarn
- Docker and Docker Compose
- MySQL (if running locally)
-
Clone the repository
git clone https://github.com/yourusername/scholarsphere.git cd scholarsphere -
Set up environment variables
# Create .env file in backend directory cp backend/.env.example backend/.env # Edit the .env file with your database credentials
-
Run with Docker Compose
docker-compose up --build
-
Access the application
- Frontend: http://localhost:3000
- Backend API: http://localhost:5001
- Database: localhost:3306
-
Clone the repository
git clone https://github.com/yourusername/scholarsphere.git cd scholarsphere -
Set up the database
# Start MySQL service # Create database: scholarspheredb
-
Install backend dependencies
cd backend npm install -
Set up environment variables
cp .env.example .env # Edit .env with your database credentials -
Run database migrations
npx prisma migrate dev npx prisma generate
-
Start the backend server
npm start
-
Install frontend dependencies
cd ../frontend npm install -
Start the frontend application
npm start
The application uses a comprehensive database schema with the following main entities:
- 👤 Users - Authentication and role management
- 🎓 Students - Student profiles and information
- 🏆 Scholarships - Available scholarship programs
- 📝 Applications - Student scholarship applications
- 📄 Documents - Application supporting documents
- 👨👩👧👦 Family Members - Student family information
- 💰 Payments - Scholarship payment tracking
- 📋 Reviews - Application review process
- 🔔 Notifications - System notifications
The system implements role-based access control with three user roles:
- 👨🎓 Student: Can submit applications, view scholarships, track payments
- 👨💼 Coordinator: Can review applications, manage students, generate reports
- 👨💻 Admin: Can manage users, providers, system settings
POST /api/auth/signup- User registrationPOST /api/auth/login- User loginPOST /api/auth/forgot-password- Password resetPUT /api/auth/password- Update password
GET /api/user/profile- Get user profilePUT /api/user/profile- Update user profile
GET /api/scholarships- Get all scholarshipsGET /api/scholarships/:id- Get specific scholarshipPOST /api/scholarships- Create scholarship (admin/coordinator)PUT /api/scholarships/:id- Update scholarship
GET /api/applications- Get user applicationsPOST /api/applications- Submit applicationGET /api/applications/:id- Get specific applicationPUT /api/applications/:id- Update application
GET /api/payments/history- Get payment historyGET /api/payments/total- Get total payments
- 📱 Responsive Design: Works seamlessly on desktop, tablet, and mobile
- 🎨 Modern Interface: Clean and intuitive user interface
- ⚡ Real-time Updates: Live notifications and status updates
- 🔍 Advanced Filtering: Search and filter scholarships and applications
- 📊 Data Visualization: Charts and statistics for better insights
# Run backend tests
cd backend
npm test
# Run frontend tests
cd frontend
npm test# Build frontend for production
cd frontend
npm run build
# Start production server
cd backend
npm startCreate a .env file in the backend directory:
DATABASE_URL="mysql://username:password@localhost:3306/scholarspheredb"
JWT_SECRET="your-secret-key"
PORT=5001- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions or need support, please:
- 📧 Email: 2022e126@eng.jfn.ac.lk
- 🐛 Report bugs: GitHub Issues
- 💬 Discussions: GitHub Discussions
- v1.0.0 - Initial release with core features
- v1.1.0 - Added payment tracking and notifications
- v1.2.0 - Enhanced reporting and analytics
- v1.3.0 - Mobile responsiveness improvements
⭐ Star this repository if you find it helpful!