NoteHub is a web application designed to facilitate the sharing of academic materials between students, teachers, and educational institutions. It provides a platform for users to register and log in with different roles (student, college, teacher, admin).
- User registration and login with different roles (student, college, teacher, admin)
- Content display
- User interaction
- File management
- NoteMate AI chat interface
- Admin dashboard with key metrics and data tables
- Analytics graphs for user registrations, home data entries, and college approvals
- HTML
- CSS (Tailwind CSS)
- JavaScript
- PHP
- MySQL
- Chart.js
- GSAP
- Install PHP and MySQL.
- Import the
database/justclick.sqlfile into your MySQL database. - Configure the database connection in the PHP files.
- Install Composer dependencies:
composer install - Run the application on a web server.
- Register an account.
- Log in with your credentials.
- Explore the available features.
- Use the NoteMate AI chat interface to get help and information.
- Admins can access the admin dashboard to view key metrics and data.
We welcome contributions to NoteHub! Please follow these guidelines:
- Code Style: Adhere to the existing code style.
- Commit Messages: Write clear and concise commit messages.
- Pull Requests: Submit pull requests for review.
MIT
- Ensure all code is well-commented and easy to understand.
- Follow a consistent coding style throughout the project.
- Test all changes thoroughly before submitting them.
- Keep the codebase clean and organized.
- Write clear and concise documentation for all new features.