diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml
new file mode 100644
index 00000000..252c8232
--- /dev/null
+++ b/.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
\ No newline at end of file
diff --git a/mkdocs/docs/advantages.md b/mkdocs/docs/advantages.md
new file mode 100644
index 00000000..5f64929c
--- /dev/null
+++ b/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.
+
+
+๐
\ No newline at end of file
diff --git a/mkdocs/docs/contributing.md b/mkdocs/docs/contributing.md
new file mode 100644
index 00000000..9e437366
--- /dev/null
+++ b/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 
+๐ Kudos to You Wonderful and Dedicated Contributors! ๐
+
+ 
+
+
+[](https://linkedin.com/in/sugam-arora-117265142) [](https://instagram.com/sugam.arora.393?utm_source=qr&igshid=MzNlNGNkZWQ4Mg%3D%3D) [](https://twitter.com/SugamArora14) [](https://facebook.com/sugam.arora.393)[](https://youtube.com/@sugamarora5997)
+[](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.
+
+
+๐
\ No newline at end of file
diff --git a/mkdocs/docs/featuresandservices.md b/mkdocs/docs/featuresandservices.md
new file mode 100644
index 00000000..208666c8
--- /dev/null
+++ b/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.
+
diff --git a/mkdocs/docs/futurescope.md b/mkdocs/docs/futurescope.md
new file mode 100644
index 00000000..2f310aca
--- /dev/null
+++ b/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.
+
+
+๐
\ No newline at end of file
diff --git a/mkdocs/docs/images/gssoc-banner.png b/mkdocs/docs/images/gssoc-banner.png
new file mode 100644
index 00000000..8edc3380
Binary files /dev/null and b/mkdocs/docs/images/gssoc-banner.png differ
diff --git a/mkdocs/docs/images/logo.png b/mkdocs/docs/images/logo.png
new file mode 100644
index 00000000..774232e7
Binary files /dev/null and b/mkdocs/docs/images/logo.png differ
diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md
new file mode 100644
index 00000000..134f7dc3
--- /dev/null
+++ b/mkdocs/docs/index.md
@@ -0,0 +1,32 @@
+# Home 
+
+
+
+
+Welcome to UniCollab, where knowledge knows no boundaries
+
+
+
+
+
+
+
+
+
+
+
+
+
+### ๐ 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.
+
+
+
+### ๐
Featured in
+
+
+ 
+
+
+๐
diff --git a/mkdocs/docs/installation.md b/mkdocs/docs/installation.md
new file mode 100644
index 00000000..dfb129c7
--- /dev/null
+++ b/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.).
+
+
+๐
\ No newline at end of file
diff --git a/mkdocs/docs/objectives.md b/mkdocs/docs/objectives.md
new file mode 100644
index 00000000..d78dbd3b
--- /dev/null
+++ b/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.
+
+๐
\ No newline at end of file
diff --git a/mkdocs/docs/purpose.md b/mkdocs/docs/purpose.md
new file mode 100644
index 00000000..8e2911d6
--- /dev/null
+++ b/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.
+
+Back to top
diff --git a/mkdocs/docs/technologystack.md b/mkdocs/docs/technologystack.md
new file mode 100644
index 00000000..7d41ca80
--- /dev/null
+++ b/mkdocs/docs/technologystack.md
@@ -0,0 +1,76 @@
+# โ Technology Stack Used
+## **Tech Stack** 
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
+ 
+
+
+
+### 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 ๐งช
+
+
+
+๐
\ No newline at end of file
diff --git a/mkdocs/docs/usage.md b/mkdocs/docs/usage.md
new file mode 100644
index 00000000..eaf1aeca
--- /dev/null
+++ b/mkdocs/docs/usage.md
@@ -0,0 +1,24 @@
+# Usage
+
+### Explore Projects
+- Browse through a variety of student projects from different universities.
+- Filter projects by category, technology, and more.
+
+### Create Your Profile
+- Sign up and create a profile showcasing your skills, projects, and aspirations.
+- Connect with other students and professionals.
+
+### Start Collaborating
+- Join existing projects or start your own.
+- Use integrated tools to collaborate seamlessly with team members.
+
+### Share Knowledge
+- Participate in discussions, ask questions, and share insights.
+- Access and contribute to a library of resources and tutorials.
+
+### Career Opportunities
+- Explore internship and job opportunities from our partner organizations.
+- Build your network and connect with potential employers.
+
+
+๐
\ No newline at end of file
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
new file mode 100644
index 00000000..765e1e1a
--- /dev/null
+++ b/mkdocs/mkdocs.yml
@@ -0,0 +1,69 @@
+site_name: Uni-Collab
+site_author: Sugam-Arora
+docs_dir: Docs
+
+theme:
+ name: material
+ feature:
+ - navigation.tabs
+ - navigation.sections
+ - toc.integrate
+ - navigation.top
+ - search.suggest
+ - search.highlight
+ - content.tabs.link
+ - content.code.annotations
+ - content.code.copy
+ palette:
+ - scheme: default
+ toggle:
+ icon: material/weather-night
+ name: Switch to dark mode
+ primary: deep blue
+ accent: deep purple
+ - scheme: slate
+ toggle:
+ icon: material/weather-sunny
+ name: Switch to light mode
+ primary: slate
+ accent: lime
+ language: en
+ logo: 'images/logo.png'
+
+
+repo_url: https://github.com/SUGAM-ARORA/UniCollab
+repo_name: Uni-Collab
+
+
+markdown_extensions:
+ - pymdownx.highlight:
+ anchor_linenums: true
+ - pymdownx.inlinehilite
+ - pymdownx.snippets
+ - admonition
+ - pymdownx.arithmatex:
+ generic: true
+ - footnotes
+ - pymdownx.details
+ - pymdownx.superfences
+ - pymdownx.mark
+ - attr_list
+ - pymdownx.emoji:
+ emoji_index: !!python/name:materialx.emoji.twemoji
+ emoji_generator: !!python/name:materialx.emoji.to_svg
+
+nav:
+ - Home: index.md
+ - Objectives: objectives.md
+ - Purpose: purpose.md
+ - Features and Services: featuresandservices.md
+ - Technology Stack Used: technologystack.md
+ - Getting Started: installation.md
+ - Usage: usage.md
+ - Advantages: advantages.md
+ - Future Scope: futurescope.md
+ - Contributing: contributing.md
+
+
+copyright: |
+ © 2024 Uni-Collab
\ No newline at end of file
diff --git a/mkdocs/requirements.txt b/mkdocs/requirements.txt
new file mode 100644
index 00000000..21f876b4
--- /dev/null
+++ b/mkdocs/requirements.txt
@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material
\ No newline at end of file