Merge pull request #434 from Abhishek-Sood/main

mkdocs site documentation

.github/workflows/mkdocs.yaml

@@ -0,0 +1,63 @@
+name: MK Docs
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "*"
+      - "Documentation-*"
+  pull_request_target:
+
+jobs:
+  build:
+    name: Build MkDocs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('mkdocs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: pip install -r mkdocs/requirements.txt
+
+      - name: Build MK Docs project
+        run: mkdocs build -f mkdocs/mkdocs.yml
+
+      - name: Upload MK Docs build files
+        uses: actions/upload-artifact@v4
+        with:
+          name: mkdocs-files
+          path: ./mkdocs/site
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/tags/Documentation-')
+
+    steps:
+      - name: Download MkDocs artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: mkdocs-files
+          path: ./mkdocs/site
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GH_PAGES_TOKEN }}
+          publish_dir: ./mkdocs/site

mkdocs/docs/advantages.md

@@ -0,0 +1,20 @@
+#✅ Advantages
+
+### Why Choose UniCollab?
+
+- **Enhanced Learning**: Learn from peers, mentors, and a wealth of shared resources.
+- **Networking Opportunities**: Connect with students, professionals, and potential employers.
+- **Project Visibility**: Showcase your projects and gain recognition for your work.
+- **Collaboration**: Work with a diverse group of students on innovative projects.
+- **Career Growth**: Discover job and internship opportunities tailored to your skills and interests.
+- **Community Support**: Be part of a supportive and engaging community.
+
+### Key Benefits
+
+- **Knowledge Sharing**: Access a wide range of tutorials, articles, and learning materials.
+- **Real-Time Collaboration**: Use integrated tools for seamless teamwork.
+- **Skill Development**: Participate in events, workshops, and collaborative projects to enhance your skills.
+- **Recognition**: Get recognized for your contributions and projects.
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/contributing.md

@@ -0,0 +1,62 @@
+# 🌱 Contributing
+
+### How to Contribute
+
+1. **Fork the Repository**: Click the "Fork" button on the top right of the repository page.
+2. **Clone Your Fork**: Clone your forked repository to your local machine.
+    ```sh
+    git clone https://github.com/YOUR-USERNAME/UniCollab.git
+    cd UniCollab
+    ```
+
+3. **Create a Branch**: Create a new branch for your feature or bugfix.
+    ```sh
+    git checkout -b feature/YourFeature
+    ```
+
+4. **Make Changes**: Make your changes to the codebase.
+
+5. **Commit Changes**: Commit your changes with a descriptive commit message.
+    ```sh
+    git add .
+    git commit -m "Add feature: YourFeature"
+    ```
+
+6. **Push to GitHub**: Push your changes to your forked repository.
+    ```sh
+    git push origin feature/YourFeature
+    ```
+
+7. **Create a Pull Request**: Go to the original repository and create a pull request.
+
+### Contribution Guidelines
+
+1. **Sync Your Fork**: Ensure your fork is up-to-date with the latest changes from the main repository to avoid conflicts.
+2. **Quality Control**: Maintain high standards for project submissions. Ensure that projects are well-documented, functional, and original.
+3. **Community Conduct**: Uphold a positive and respectful community environment. Any form of harassment, discrimination, or inappropriate behavior will not be tolerated.
+4. **Feedback Etiquette**: Provide constructive and respectful feedback. Avoid negative or discouraging comments that do not contribute to the improvement of the project.
+5. **Data Privacy**: Ensure that sensitive information is protected and not shared without consent. Follow best practices for data security.
+6. **Compliance with Guidelines**: Adhere to all platform guidelines and policies. Regularly review updates to ensure continued compliance.
+
+
+###  Contributors <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="30" height="30" />
+<div align =center><h3>🎉 Kudos to You Wonderful and Dedicated Contributors! 🌟</h3> <br>
+<a href="https://github.com/SUGAM-ARORA/UniCollab/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=SUGAM-ARORA/UniCollab" />
+</a>
+</div>
+
+### 📬 Contact Details
+
+You can connect with me on various platforms:<br>
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-%230077B5.svg?logo=linkedin&logoColor=white)](https://linkedin.com/in/sugam-arora-117265142) [![Instagram](https://img.shields.io/badge/Instagram-%23E4405F.svg?logo=Instagram&logoColor=white)](https://instagram.com/sugam.arora.393?utm_source=qr&igshid=MzNlNGNkZWQ4Mg%3D%3D) [![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?logo=Twitter&logoColor=white)](https://twitter.com/SugamArora14) [![Facebook](https://img.shields.io/badge/Facebook-%231877F2.svg?logo=Facebook&logoColor=white)](https://facebook.com/sugam.arora.393)[![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?logo=YouTube&logoColor=white)](https://youtube.com/@sugamarora5997)
+[![Gmail](https://img.shields.io/badge/Gmail-%23FFFFFF.svg?logo=gmail&logoColor=red)](mailto:sugam.arora23@gmail.com)
+
+### 🌟 Join Us 
+
+Ready to embark on a journey of collaborative learning? Join UniCollab now and be a part of a community that believes in the power of collaboration!
+
+Thank you for contributing to our open-source project! We appreciate your support and look forward to your valuable contributions.
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/featuresandservices.md

@@ -0,0 +1,13 @@
+# 🚀 Features and Services
+
+### Key Features
+- **Project Showcase:** Showcase your projects and discover what other students are working on.
+- **Collaborative Tools:** Work together seamlessly with integrated collaboration tools.
+- **Knowledge Sharing:** Share insights, tips, and tricks with a community passionate about learning.
+- **Career Opportunities:** Explore internship and job opportunities from our partner organizations.
+
+### Additional Services
+- **Community Support:** Join discussions, ask questions, and get feedback from peers and mentors.
+- **Resource Library:** Access a collection of tutorials, articles, and learning materials.
+- **Events and Workshops:** Participate in events and workshops to enhance your skills and network.
+

mkdocs/docs/futurescope.md

@@ -0,0 +1,20 @@
+# 🔭 Future Scope
+
+### Planned Enhancements
+
+- **Global Expansion**: Reach out to more universities worldwide to expand the user base.
+2. **Industry Partnerships**: Collaborate with tech companies and institutions to provide more opportunities.
+3. **Professional Integration**: Connect with LinkedIn and GitHub for enhanced professional networking.
+4. **Feature Upgrades**: Regular updates based on user feedback and emerging trends.
+5. **Advanced Collaboration Tools**: Integrate more advanced tools for seamless collaboration.
+6. **Mobile App**: Develop a mobile application for on-the-go access.
+7. **Enhanced Security**: Continuously improve security measures to protect user data.
+8. **AI and Machine Learning**: Implement AI and machine learning features for personalized learning and project recommendations.
+
+### User-Driven Evolution
+
+- Regular surveys and feedback sessions to understand user needs.
+- Continuous improvement based on user suggestions and industry trends.
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/index.md

@@ -0,0 +1,32 @@
+# Home <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Writing%20Hand%20Light%20Skin%20Tone.png" alt="Rocket" width="30" height="30" />
+<center> 
+<img src="https://readme-typing-svg.herokuapp.com/?color=F75102&size=40&width=900&height=60&lines=UniCollab:%20Unleashing%20Collaborative%20Learning"> 
+</center>
+
+<h3><p align="center">Welcome to UniCollab, where knowledge knows no boundaries</h3></p>
+
+![PRs Welcome](https://img.shields.io/badge/PRs-welcome-cyan.svg?style=badge&color=F78634&logo=openai)
+![GitHub forks](https://img.shields.io/github/forks/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub Repo stars](https://img.shields.io/github/stars/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub contributors](https://img.shields.io/github/contributors/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub last commit](https://img.shields.io/github/last-commit/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub repo size](https://img.shields.io/github/repo-size/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![Github](https://img.shields.io/github/license/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub issues](https://img.shields.io/github/issues/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/SUGAM-ARORA/Unicollab?style=badge&color=F78634&logo=openai)
+
+### 👋 About UniCollab 
+
+UniCollab is more than just a platform; it's a gateway to a world where students from different universities/colleges converge to collaborate, innovate, and elevate their projects. Imagine a space where ideas flow freely, where knowledge is shared effortlessly, and where learning transcends classrooms. That's UniCollab for you.
+
+![Visitors](https://api.visitorbadge.io/api/visitors?path=SUGAM-ARORA/Unicollab%20&style=badge&logo=openai)
+
+### 🏅 Featured in 
+
+<p align="center">
+  <img src="images/gssoc-banner.png">
+</p>
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/installation.md

@@ -0,0 +1,44 @@
+# 🛠️ Installation
+
+### Prerequisites
+- Node.js and npm installed
+- MongoDB set up
+- Firebase account
+
+### Steps
+1. **Clone the repository:**
+    ```sh
+    git clone https://github.com/SUGAM-ARORA/UniCollab.git
+    cd UniCollab
+    ```
+
+2. **Install dependencies:**
+    ```sh
+    npm install
+    ```
+
+3. **Set up environment variables:**
+    - Create a `.env` file in the root directory.
+    - Add your MongoDB URI, Firebase credentials, and other required variables.
+
+4. **Start the development server:**
+    ```sh
+    npm start
+    ```
+
+5. **Open your browser and navigate to:**
+    ```
+    http://localhost:3000
+    ```
+
+## Building the Project
+- To build the project for production, run:
+    ```sh
+    npm run build
+    ```
+
+## Deployment
+- Follow the deployment instructions for your chosen platform (AWS, Firebase, etc.).
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/objectives.md

@@ -0,0 +1,28 @@
+# 🎯 Objectives
+
+### Mission 📚
+To create a dynamic platform where students from diverse universities collaborate, innovate, and showcase their projects, driving learning and recognition.
+
+### Core Objectives 👥
+1. **Foster Collaboration**: Enable seamless teamwork on projects.
+2. **Enhance Learning**: Provide resources and a community for mutual learning.
+3. **Showcase Projects**: Offer a stage for students to display their work and talents.
+4. **Inspire Innovation**: Encourage creative and impactful projects.
+5. **Build Community**: Cultivate a supportive network for feedback and growth.
+
+### Long-Term Goals 🔄
+1. **Global Reach**: Expand to more universities worldwide.
+2. **Industry Partnerships**: Collaborate with tech companies and institutions.
+3. **Professional Integration**: Connect with LinkedIn and GitHub.
+4. **Continuous Evolution**: Regular updates based on feedback and trends.
+
+### Success Metrics 📈
+1. **User Engagement**: Activity levels and collaboration rates.
+2. **Growth**: Increase in users and projects.
+3. **Satisfaction**: Regular feedback and user satisfaction surveys.
+4. **Learning Impact**: User testimonials and success stories.
+5. **Community Activity**: Discussions, contributions, and events.
+
+By embracing these goals, UniCollab aims to be the premier platform for student collaboration and innovation.
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>

mkdocs/docs/purpose.md

@@ -0,0 +1,5 @@
+# 📝 Purpose
+
+UniCollab aims to bring together students from various universities and colleges, fostering an environment of collaboration, innovation, and mutual learning. By providing a platform for showcasing projects, sharing knowledge, and connecting with like-minded individuals, UniCollab seeks to transcend traditional classroom boundaries and create a vibrant, supportive community for students.
+
+<p align="right"><a href="#top">Back to top</a></p>

mkdocs/docs/technologystack.md

@@ -0,0 +1,76 @@
+# ⚛ Technology Stack Used
+## **Tech Stack** <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/High%20Voltage.png" alt="High Voltage" width="30" height="30" />
+
+<p align="center">
+  <a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5">
+    <img src="https://img.shields.io/badge/HTML5-E34F26.svg?style=for-the-badge&logo=HTML5&logoColor=white">
+  </a>
+  <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">
+    <img src="https://img.shields.io/badge/JavaScript-F7DF1E.svg?style=for-the-badge&logo=JavaScript&logoColor=black">
+  </a>
+  <a href="https://docs.mongodb.com/">
+  <img src="https://img.shields.io/badge/MongoDB-4EA94B.svg?style=for-the-badge&logo=MongoDB&logoColor=white">
+  </a>
+  <a href="https://aws.amazon.com/">
+    <img src="https://img.shields.io/badge/AWS-232F3E.svg?style=for-the-badge&logo=Amazon AWS&logoColor=white">
+  </a>
+  <a href="https://firebase.google.com/">
+    <img src="https://img.shields.io/badge/Firebase-FFCA28.svg?style=for-the-badge&logo=Firebase&logoColor=black">
+  </a>
+  <a href="https://pytorch.org/">
+    <img src="https://img.shields.io/badge/PyTorch-EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white">
+  </a>
+  <a href="https://www.docker.com/">
+    <img src="https://img.shields.io/badge/Docker-2496ED.svg?style=for-the-badge&logo=Docker&logoColor=white">
+  </a>
+  <a href="https://www.tensorflow.org/">
+    <img src="https://img.shields.io/badge/TensorFlow-FF6F00.svg?style=for-the-badge&logo=TensorFlow&logoColor=white">
+  </a>
+  <a href="https://numpy.org/">
+    <img src="https://img.shields.io/badge/NumPy-013243.svg?style=for-the-badge&logo=NumPy&logoColor=white">
+  </a>
+
+  <a href="https://developer.mozilla.org/en-US/docs/Web/CSS">
+    <img src="https://img.shields.io/badge/CSS3-1572B6.svg?style=for-the-badge&logo=CSS3&logoColor=black">
+  </a>
+</p>
+
+### Backend
+- **Node.js with Express.js** for the server 💻
+- **MongoDB** for the database (using Mongoose for object modeling) 📊
+- **Firebase Authentication** for user authentication and authorization 🔐
+- **Firebase Cloud Functions** for serverless backend logic ☁️
+
+### Frontend
+- **React.js** for a dynamic and responsive user interface ⚛️
+- **HTML5, CSS3, JavaScript** for elegant and modern design 🎨
+- **Firebase Hosting** for fast and secure web hosting 🚀
+- **Firebase Realtime Database** for real-time data synchronization 🔥
+
+### DevOps & Deployment
+- **Continuous Integration/Continuous Deployment (CI/CD):** GitLab CI/CD for automated testing and deployment 🔄
+- **Containerization:** Docker for efficient and scalable deployment 🐳
+- **Orchestration:** Kubernetes for managing containerized applications ⚙️
+
+### Cloud Platform
+- **Hosting:** AWS (Amazon Web Services) for reliable and scalable hosting ☁️
+- **Serverless Computing:** AWS Lambda for cost-effective and scalable backend services 🚀
+- **Storage:** AWS S3 for secure and scalable storage solutions 📦
+
+### Machine Learning & AI
+- **Frameworks:** TensorFlow and PyTorch for advanced machine learning capabilities 🧠
+- **Libraries:** scikit-learn, pandas, NumPy for data manipulation and analysis 📊
+- **Deployment:** Docker containers for easy deployment of machine learning models 🐳
+
+### Database
+- **MongoDB** for flexible and scalable NoSQL database solutions 📊
+
+### Other Tools and Technologies
+- **Websockets** for real-time communication and collaboration features 🔄
+- **Security:** JWT (JSON Web Tokens) for secure authentication and authorization 🔒
+- **Data Visualization:** D3.js or Chart.js for interactive and visually appealing data representation 📊
+- **Testing:** Jest for React.js unit testing, Selenium for end-to-end testing 🧪
+
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>