The web application, built using ReactJS, is designed to assist students in making informed decisions regarding their undergraduate studies. It provides a platform for students to explore and choose the right stream/branch that aligns with their interests and career aspirations. Additionally, the app leverages real and honest insights from current college students to help students choose the right and convenient college based on their specific needs and preferences. This app serves as a valuable resource for students looking to make the most of their undergraduate education and embark on a successful career path.
- About Councellor 🧑🎓
- Features 🎊
- Technologies Used 🧑💻
- Installation Guide 👩💻⚙️
- How to use? 👤
- View our site live! 🤩🤩
- View Contributing Guidelines 📜
- Licenses 🗞️🗞️
- Let's Connect 🔗
- Contact Project Admin 📞
- Our Valuable Contributors 🌟🌟
- User registration and login system
- Anonymously connect users with trained counsellors
- Real-time messaging between users and counsellors
- Secure and private communication using encryption
- User-friendly interface for easy navigation
- User profile customization options
- Easy access to previous chat history
- Frontend: HTML, CSS, JavaScript
- Backend: Node.js, Express.js,Firebase
- Database: MongoDB
- Real-time Messaging: Socket.IO
- Encryption: bcrypt, crypto
-
Clone this repository to your local machine using:
git clone https://github.com/thestarsahil/Counsellor.git -
Navigate to the project directory:
cd Counsellor -
Build the docker image
docker build -t counsellor-web . -
Run the docker image
docker run -p 5173:5173 counsellor-web
To run Counsellor locally, follow these steps:
-
Clone this repository to your local machine using:
git clone https://github.com/thestarsahil/Counsellor.git -
Navigate to the project directory:
cd Counsellor -
Install the required dependencies using npm:
npm install -
Configure Firebase: Create an account on firebase https://console.firebase.google.com/ and craete a project in it.
- Useful Resource: A ChatGPT chat for configuring firebase.
-
Create .env file and add all the firebase environment variables listed in .env.example file with valid values.
-
Start the server:
npm run dev -
Open your web browser and visit
http://localhost:5173to access the Counsellor application.
Once the application is running, users can register or log in to their accounts. After logging in, they can choose to start a chat with a counsellor. The chat interface allows real-time messaging between the user and the assigned counsellor. Users can customize their profile and view their chat history.
Demo -> Live site
Contributions to Counsellor are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue on the GitHub repository.
Before contributing, please review the Contributing Guidelines.
This project is licensed under the MIT License. See the LICENSE file for more information.
For any inquiries or questions regarding Counsellor, please contact the project owner: Sahil Ali .
Thank you for your interest in Counsellor! We hope it can provide valuable support to those in need.