ScholarQuest Documentation

Admin Credentials

• Username: [email protected]
• Password: AAAAAA@

Live Site URL

ScholarQuest Live

Features

1. User Roles:

   • Users, Moderators, and Admins
   • Role changes managed by Admins

2. Home Page:

   • Navbar with logo, Home, All Scholarship, User Dashboard, Admin Dashboard, Login & Logout buttons
   • Banner with slider for advertisements
   • Top Scholarships section showcasing top 6 scholarships
   • Student Review section
   • Contact Us section
   • Additional customizable section

3. Scholarship Details:

   • Detailed scholarship information
   • Application process with payment integration
   • User reviews and ratings

4. User Authentication:

   • Email and password-based authentication
   • Social login option
   • User registration with validation
   • Responsive error handling

5. User Dashboard:

   • My Profile: View and update user information
   • My Applications: Track applied scholarships
   • My Reviews: Manage user reviews

6. Admin Dashboard:

   • Manage Scholarships: Add, edit, and delete scholarships
   • Manage Applications: Review and provide feedback on applications
   • Manage Users: Update user roles and delete users
   • Manage Reviews: Oversee user reviews

7. Moderator Dashboard:

   • Manage Scholarships: Similar to Admin management
   • Review Management: Oversee reviews
   • Application Management: Track and manage applications
   • Add Scholarships: Add new scholarships to the system

8. Responsive Design:

   • Mobile, tablet, and desktop friendly
   • Responsive dashboards

9. CRUD Operations:

   • Toast notifications for create, read, update, delete operations
   • User-friendly interfaces without browser alerts

10. Environment Variables:

• Secure storage of Firebase config keys and MongoDB credentials

Getting Started

Prerequisites

• Node.js
• MongoDB
• Firebase account

Installation

1. Clone the repository:

git clone https://github.com/Istiak-A-Tashrif/ScholarQuest-client.git
cd scholarquest

2. Install the dependencies:

npm install

3. Set up environment variables:

• Create a .env file in the root directory
• Add your Firebase config keys and MongoDB credentials

4. Run the application:

npm start

Repository Links

• Server Side GitHub Repository

Contributions

We welcome contributions to improve ScholarQuest. Please fork the repository and create a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

1. Introduction ScholarQuest is designed to help students find and apply for scholarships that match their qualifications and preferences. This system provides a user-friendly interface for managing scholarships and applications, enhancing the efficiency and effectiveness of the scholarship search and application process.

2. Features Overview

• Home Page: Engaging and informative home page with easy navigation.
• Scholarship Search: Advanced search functionality to find scholarships based on various criteria.
• Application Tracking: Users can track the status of their scholarship applications.
• User Reviews: Users can provide and view reviews for scholarships.
• Admin and Moderator Dashboards: Comprehensive dashboards for managing scholarships, users, and applications.

3. Technical Specifications

• Frontend: Built with React.js for a responsive and dynamic user interface.
• Backend: Node.js and Express.js for server-side logic.
• Database: MongoDB for storing user and scholarship data.
• Authentication: Firebase Authentication for secure login and registration.
• Hosting: Deployed on [Your Hosting Service] for reliable and scalable access.

4. User Guide

• Registering an Account: Step-by-step instructions on how users can register and verify their accounts.
• Searching for Scholarships: Detailed guide on using the search functionality to find relevant scholarships.
• Applying for Scholarships: Instructions on how to apply for scholarships, including document submission and payment integration.
• Tracking Applications: How to track the status of submitted applications.
• Managing Profile: Guide on updating user profile information and settings.

Support

For support or questions, please contact Support Email.