Schedio

A trustworthy platform connecting recruiters and students.
Report Bug · Request Feature · View Website

---

Table of Contents

Expand

1. About The Project
   • Built With
   • Features
   • General Features
   • T1 Users (Student/Employee)
   • T2 Users (College/Organization)
   • T3 Users (Recruiter)
2. Getting Started
3. Contributing
4. Screenshots
5. License
6. Contact

---

About The Project

Schedio provides a platform for students/employees, colleges/organizations, and recruiters to collaborate. It simplifies sharing and understanding projects, offers advanced search and filtering tools, and enables recruiters to discover the right talent.

---

Built With

---

Features

General Features

1. User Authentication with email (forgot password support)
2. Comprehensive skill dataset
3. Plagiarism check using RapidAPI
4. Upload support for videos, code files, and images
5. Tree-like code structure viewer
6. Code explanation powered by Gemini
7. Session persistence for seamless user experience

Note:- T stands for Type

T1 User Features (Student/Employee)

1. View all projects
2. Search projects by programming language
3. Tokenized search across projects
4. Comment/Like functionality on projects
5. Can be added as contributors by T2 users on project uploads.
6. Add/Edit profile picture and custom Student Description
7. Auto generates Description on Signing up

T2 User Features (College/ Organisation)

1. View only their T1 users' projects.
2. Monthly Analytics.
3. Upload projects for T1 users.
4. Auto-sync skills and projects with T1 profiles.
5. View and download T1 user profiles as PDFs.

T3 User Features (Recruiter)

1. Access to all projects.
2. Comment on any project.
3. Filter by Institute or Domain.
4. View and download T1 user profiles.
5. Bookmark users for quick reference.
6. Tokenized search across projects.
7. Tokenized search across students.

---

Getting Started

To run the project locally, follow these steps.

Prerequisites

• Node.js & npm
• MongoDB Database
• Git
• Plagiarism Check API Key: Get it here
• Gemini API Key: Get it here

Installation

1. Clone the repository:

   git clone https://github.com/vsreddyh/schedio.git

2. Install dependencies:

   cd frontend && npm install
   cd ../backend && npm install

3. Create a .env file in the ./backend folder with the following structure:

   EMAIL=[email protected]
   PASSWORD=your-app-password
   JWT_SECRET=random-32-characters
   SESSION_KEY=random-32-characters
   plagarismapi=your-rapidapi-key
   geminiapi=your-gemini-api-key
   url=mongodb://your-connection-url/database-name?retryWrites=true&w=majority

4. Start the project:

   npm run build && node index.js

---

Contributing

We welcome contributions of all kinds! Whether it's bug reports, feature suggestions, code improvements, or documentation updates, your help is valuable. Here's how you can get involved:

How to Contribute

1. Fork the Repository Click the Fork button at the top-right corner of the repository to create a copy of this project on your GitHub account.

2. Clone the Repository Clone your forked repository locally to make changes:

   git clone https://github.com/your-username/schedio.git
   cd schedio

3. Create a New Branch Use meaningful branch names to reflect the type of changes you are making:

   git checkout -b feature/your-feature-name

   Example:
   feature/user-authentication or feature/fix-login-issue

4. Make Your Changes Ensure your changes follow the code style used in the project and include comments where needed. If your change adds new functionality, consider updating or adding tests.

5. Commit Your Changes Write clear, concise commit messages to describe the changes you made:

   git commit -m "clear and concise commit name"

6. Push Your Branch to GitHub Push the branch to your forked repository:

   git push origin feature/your-feature-name

7. Open a Pull Request (PR) Go to the original repository and click New Pull Request. Make sure to:

   • Provide a descriptive title.
   • Reference any related issues (e.g., Closes #10).
   • Explain the purpose of your changes and any relevant details in the PR description.

---

Guidelines for Contributions

• Follow Code Standards: Ensure your code follows the project’s existing conventions.
• Document Changes: Update documentation if your changes introduce new features or require configuration updates.
• Test Your Code: Make sure any new or modified functionality works as expected.
• Respect Others: Be kind and constructive in discussions, reviews, and comments.

---

Reporting Issues and Suggesting Features

If you encounter bugs or have ideas for new features, please open an issue:

• Report Bugs: Create a Bug Report
• Request Features: Suggest a Feature

Make sure to:

• Provide as much detail as possible.
• Include steps to reproduce bugs, if applicable.

---

Thank You for Contributing! 🎉

Your effort makes a huge difference! Every bug report, feature request, and pull request helps us improve and grow this project.

---

Screenshots

Project Page

Opening a File in Project's Code files

Using Gemini to explain code files

Suggestions for language filters

Liked Projects in T1 users page

T1 user Profile Page

Log out option in T1 users

Organization HomePage

Student Page viewed by T3,T2 users

Filtering by college in Recruiter page

Bookmarks in recruiter page

---

License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for more details.

---

Contact

Have questions? Reach us at [email protected].