Skip to content

Latest commit

 

History

History
147 lines (121 loc) · 6.21 KB

Learn.md

File metadata and controls

147 lines (121 loc) · 6.21 KB
Raw

Learn.md: Comprehensive Guide to College.ai

Welcome to College.ai! This document will guide you through understanding, setting up, and contributing to the project. Whether you are a beginner or an experienced developer, this guide will help you get started with College.ai and make meaningful contributions.

Table of Contents 📅

  1. Introduction
  2. Dependencies
  3. Installation
  4. Launching
  5. Using College.ai
  6. Contributing
  7. Resources for Beginners
  8. Documentation
  9. Code Reviews
  10. Feature Requests
  11. Spreading the Word

Introduction🎬

College.ai is a versatile project that leverages the power of ChatGPT-4 to offer a variety of features, including exploring ChatGPT-4 functionalities, uploading and querying PDFs, analyzing resumes, and matching job descriptions with resumes. This guide will help you navigate through the setup process, understand the project's structure, and contribute effectively.

Dependencies 💡

Before installing College.ai, ensure you have the following dependencies installed:

You can install all the dependencies using the following command:

pip install -r requirements.txt

Installation 🛠️

  1. Clone the repository: 
    git clone <link>
  2. Navigate to the Project Directory: 
    cd <filename>

Launching

To start the College.ai application, run the following command:

streamlit run <app.py>

This will launch the College.ai application in your default web browser.

✨ Using College.ai ✨

Home Page🏠

The Home page provides an overview of the project and its functionalities.

About Section

Learn more about the creator and the purpose behind College.ai.

Ask_To_PDF

Upload and train PDFs, then query them using ChatGPT-4.

Resume Analyser

Upload resumes to get detailed analysis and recommendations for improvement.

ATS

Match job descriptions with resumes to see how well they align and get feedback on improvements.

Prompt Examples

Explore various examples to help you understand how to effectively use the Ask_To_PDF functionality.

Contributing 📝

Raise and issue; Get assigned and then work on fixing the issue. We welcome contributions to College.ai! Follow these steps to contribute:

  1. Fork the Repository: Create your own copy of the repository on your GitHub account. image
  2. Clone the Repository : Clone the repository for making commits. 
    git clone https://github.com/SurajSanap/College.ai-main.git

image 3. Create a New Branch for your feature or bug fix: Make a separate branch to work on specific features or fixes and switch to the correct branch.

git checkout -b <new-branch-name>
  1. Make Changes and commit them: Implement your changes and save them with a descriptive commit message.
git add .
git commit -m "Describe your changes"
  1. Push Your Changes to your fork: Upload your committed changes to your GitHub fork. 
    git push origin <branch_name>
  2. Create a Pull Request ✅: Propose your changes to be merged into the original repository. image

Development Workflow

  • Always work on a new branch for each issue or feature.
  • Keep your branch up to date with the main repository's master branch.
  • Write clear and descriptive commit messages.
  • Test your changes thoroughly before submitting a pull request.

Issue Report Process

  1. Go to the project's issues section.
  2. Select the appropriate template for your issue.
  3. Provide a detailed description of the issue.
  4. Wait for the issue to be assigned before starting to work on it.

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code.
  2. Make sure you have added the proper description for the functionality of the code.
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.

Resources for Beginners 📚

Basics of Git and GitHub 📂

📍Documentation

  • Document any significant changes or additions to the codebase.
  • Provide clear explanations of the functionality, usage, and any relevant considerations.

Code Reviews

  • Be open to feedback and constructive criticism from other contributors.
  • Participate in code reviews by reviewing and providing feedback.

Feature Requests 🔥

  • Suggest new features or improvements that would enhance the project.

Spreading the Word 👐

  • Share your experience and the project with others.
  • Spread the word about the project on social media, developer forums, or any relevant community platforms.

Thank you for contributing to College.ai! Together, we can make a significant impact. Happy coding! 🚀 Don't forget to ⭐ the repository!