Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added A Template Page Where Users can See Resume Templates #1005

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 104 additions & 50 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,155 @@
Here's the revised `CONTRIBUTING.md` file with your additional instructions:

---
# LinkedIn Resume Builder ✨

This project is a LinkedIn Resume Builder that allows users to generate professional resumes from their LinkedIn profiles in just a few clicks. The website is designed with a clean and responsive UI using Bootstrap, focusing on simplicity and ease of use.
Comment on lines +2 to +4
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Ensure project name consistency across documentation.

The project is referred to as "LinkedIn Resume Builder" here, but the PR objectives mention "Resum-Resume". This inconsistency might confuse contributors.

Consider updating the title to match the actual project name:

-# LinkedIn Resume Builder ✨
+# Resum-Resume ✨
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# LinkedIn Resume Builder
This project is a LinkedIn Resume Builder that allows users to generate professional resumes from their LinkedIn profiles in just a few clicks. The website is designed with a clean and responsive UI using Bootstrap, focusing on simplicity and ease of use.
# Resum-Resume ✨
This project is a LinkedIn Resume Builder that allows users to generate professional resumes from their LinkedIn profiles in just a few clicks. The website is designed with a clean and responsive UI using Bootstrap, focusing on simplicity and ease of use.


## Features 🚀

- **Easy-to-Use Interface:** A user-friendly interface allows users to effortlessly create a resume.
- **Instant Resume Generation:** Quickly build a resume by entering your LinkedIn profile URL.
- **Secure Data:** Personal information is protected through encrypted communication 🔒.
- **Responsive Design:** The website is mobile-first and adjusts seamlessly to different screen sizes 📱.
- **24/7 Support:** Support is available around the clock to assist users 💬.

## Project Structure 📁

The website consists of the following key sections:

- **Navbar:** A top navigation bar with links to the homepage, resume builder, sign-up, and login pages.
- **Hero Section:** A CTA section encouraging users to start building their resume.
- **Features Section:** Highlights core features of the platform.
- **Testimonials Section:** Displays user feedback and testimonials to boost credibility.
- **Footer:** A simple footer providing basic information about the website.

# Contributing to LinkedIn Resume Builder 🤝
## Technologies Used 💻

Thank you for your interest in contributing to the LinkedIn Resume Builder project! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.
- **HTML5:** Structure of the webpage.
- **CSS3:** Styling and layout, using Google Font Roboto for typography.
- **Bootstrap 4.5:** Ensures responsiveness and aesthetic appeal.
- **JavaScript/jQuery:** Handles dynamic behavior.

## Table of Contents 📚
## Screenshots 📸

- [Forking the Repository](#forking-the-repository)
- [Setting Up the Development Environment](#setting-up-the-development-environment)
- [Submitting Issues](#submitting-issues)
- [Submitting Pull Requests](#submitting-pull-requests)
- [Coding Style and Best Practices](#coding-style-and-best-practices)
- [Running Tests](#running-tests)
- [Code of Conduct](#code-of-conduct)
- **Desktop and Mobile View:** Available to preview on both desktop and mobile screens.

## Forking the Repository 🍴
## Getting Started 🏁

1. Click on the **Fork** button at the top right corner of the repository page.
2. Clone your forked repository to your local machine:
### Prerequisites

- A modern web browser (Chrome, Firefox, Safari, etc.)
- Internet connection to load external resources (Bootstrap, fonts)

### Installation

1. **Clone the repository:**
```bash
git clone https://github.com/your-username/linkedin-resume-builder.git
cd linkedin-resume-builder
```

3. Navigate to the project directory:
2. **Open the index.html file:**
```bash
open index.html
```

### File Structure 📂

```plaintext
├── index.html # Main homepage
├── resume.html # Resume builder page
├── signup.html # Sign-up page
├── login.html # Log-in page
├── about.html # About page
├── Hero Section.jpg # Image displayed in the hero section
├── styles.css # Custom CSS styles (inlined in HTML)
```
Comment on lines +57 to +65
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Update file structure to include template-related files.

The file structure is missing the new template-related files that are being added in this PR, such as template_type.html. Additionally, ensure the repository URLs are updated with the correct organization name.

Update the file structure to include new files:

 ├── index.html          # Main homepage
 ├── resume.html         # Resume builder page
+├── template_type.html  # Resume templates page
 ├── signup.html         # Sign-up page
 ├── login.html          # Log-in page
 ├── about.html          # About page

Committable suggestion skipped: line range outside the PR's diff.


## Developer Setup 🛠️

For developers who want to contribute:

1. Clone the repository:
```bash
git clone https://github.com/your-username/linkedin-resume-builder.git
cd linkedin-resume-builder
```

2. Install necessary dependencies if applicable (e.g., Node.js, Python).
3. Run the development server:
```bash
npm start
```
Comment on lines +77 to +81
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Clarify development environment setup requirements.

The setup instructions mention npm and running a development server, but there's no information about:

  • Required Node.js version
  • Project dependencies
  • Package.json configuration
  • Development server configuration

Consider adding more detailed setup instructions or removing npm-specific commands if they're not applicable to this static HTML project.


## Submitting Issues 🐛

If you find a bug or have a feature request, please submit an issue by following these steps:
## Contributing 🤝

1. Navigate to the **Issues** tab of the repository.
2. Click on the **New Issue** button.
3. Fill out the issue template with the necessary details. Please include:
- A brief description of the issue.
- Screenshots (if applicable) to illustrate the problem.
We welcome contributions in various forms, including code, documentation, and feedback. Here’s how you can get started:

## Submitting Pull Requests 🔄
### How to Contribute

To submit a pull request:
1. **Fork the Repository**

1. **Star the Repository** ⭐: If you find this project helpful, please star the repository to show your support!
Navigate to the [GitHub repository](https://github.com/your-username/linkedin-resume-builder) and click **Fork** to create your copy.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Update repository URLs and enhance contribution guidelines.

The repository URLs contain placeholder usernames and need to be updated. Additionally, consider adding:

  • Branch naming conventions
  • Commit message format guidelines
  • Pull request template
  • Issue template

Update the URLs to use the correct repository:

-[GitHub repository](https://github.com/your-username/linkedin-resume-builder)
+[GitHub repository](https://github.com/GarimaSingh0109/Resum-Resume)

Also applies to: 96-96, 129-129


2. Ensure your fork is up to date with the main repository:
2. **Clone Your Fork**

```bash
git checkout main
git pull upstream main
git clone https://github.com/your-username/linkedin-resume-builder.git
cd linkedin-resume-builder
```

3. Create a new branch for your feature or fix:
3. **Create a Branch**

```bash
git checkout -b your-branch-name
git checkout -b feature/your-feature-name
```

4. Make your changes and commit them:
4. **Make Changes**

Implement changes or new features following the project's coding style.

5. **Commit Your Changes**

```bash
git add .
git commit -m "Add a brief description of your changes"
git commit -m "Add description of your changes"
```

5. Push your branch to your forked repository:
6. **Push to Your Branch**

```bash
git push origin your-branch-name
git push origin feature/your-feature-name
```

6. Go to the original repository and create a pull request. In your pull request:
- Write a brief description of the changes.
- Include before and after screenshots (if applicable).
- Mention the issue number that your pull request addresses.
7. **Open a Pull Request**

In the original repository, click **Pull Requests** and submit a pull request with a detailed description of your changes.

### Reporting Issues

If you encounter issues, please report them in the [Issues section](https://github.com/your-username/linkedin-resume-builder/issues) with a detailed description.

### Code of Conduct

7. After your pull request is merged, please delete your forked repository and fork it again to avoid clashes when merging other issues.
By participating in this project, you agree to adhere to a respectful and inclusive code of conduct.

## Coding Style and Best Practices 💻
## Usage 📄

- Follow the [JavaScript Standard Style](https://standardjs.com/) for coding conventions.
- Write clear and concise commit messages.
- Ensure your code is well-documented and easy to understand.
- Add screenshot in issue and pr description.

- **Home Page:** Introduces users to the service with a description and CTA button.
- **Build Resume:** Users enter their LinkedIn URL to create a resume.
- **Sign-Up/Login:** Users can create an account or log in to manage their resume.
- **Features & Testimonials:** Displays platform features and user feedback.
Comment on lines +137 to +140
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Document the new resume templates feature.

The usage section should include information about the new resume templates feature being added in this PR.

Add a new bullet point to describe the template feature:

 - **Build Resume:** Users enter their LinkedIn URL to create a resume.
+- **Resume Templates:** Browse and select from various professional resume templates.
 - **Sign-Up/Login:** Users can create an account or log in to manage their resume.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Home Page:** Introduces users to the service with a description and CTA button.
- **Build Resume:** Users enter their LinkedIn URL to create a resume.
- **Sign-Up/Login:** Users can create an account or log in to manage their resume.
- **Features & Testimonials:** Displays platform features and user feedback.
- **Home Page:** Introduces users to the service with a description and CTA button.
- **Build Resume:** Users enter their LinkedIn URL to create a resume.
- **Resume Templates:** Browse and select from various professional resume templates.
- **Sign-Up/Login:** Users can create an account or log in to manage their resume.
- **Features & Testimonials:** Displays platform features and user feedback.


## Responsive Design 📏

This project uses Bootstrap’s grid system to ensure full responsiveness across screen sizes, with additional media queries for layout fine-tuning on mobile devices.

## Code of Conduct 📜
## Thank You!

By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please treat everyone with respect and kindness.
Thank you for contributing to the LinkedIn Resume Builder! Your contributions help us build a better tool for users. Happy coding!

---

Thank you for contributing to the LinkedIn Resume Builder project! We appreciate your help in making it a better resource for everyone. If you have any questions, feel free to reach out!
**Screenshot Discord Link:** [Join Discord](https://discord.gg/GJ5BfwVd)
```

Replace `your-username` in the GitHub links with the actual username if this will be published in your repository. This combined format keeps everything accessible in a single file for simplicity and easy access for contributors.
1 change: 1 addition & 0 deletions RateMyResume.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<a href="#home">Home</a>
<a href="about.html">About</a>
<a href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
<a href="RateMyResume.html">RateMyResume</a>
<a href="signup.html">Sign Up</a>
<a href="login.html">Login</a>
Expand Down
Binary file added Template Images/Template-1.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Template Images/Template-2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Template Images/Template-3.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Template Images/Template-4.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Template Images/Template-5.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Template Images/Template-6.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions about.html
Original file line number Diff line number Diff line change
Expand Up @@ -476,6 +476,7 @@
<a href="#home">Home</a>
<a href="about.html">About</a>
<a href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
<!-- <a href="signup.html">Sign Up</a> -->
<!-- <a href="login.html">Login</a> -->
</nav>
Expand Down Expand Up @@ -505,6 +506,7 @@
<a href="#home">Home</a>
<a href="about.html">About</a>
<a href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
</div>
<div class="auth-links">
<a href="signup.html">Sign Up</a>
Expand Down
2 changes: 2 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -912,6 +912,7 @@
<a href="#home">Home</a>
<a href="about.html">About</a>
<a href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
<!-- <a href="signup.html">Sign Up</a> -->
<!-- <a href="login.html">Login</a> -->
</nav>
Expand Down Expand Up @@ -941,6 +942,7 @@
<a href="#home">Home</a>
<a href="about.html">About</a>
<a href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
</div>
<div class="auth-links">
<a href="signup.html">Sign Up</a>
Expand Down
9 changes: 5 additions & 4 deletions login.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@
<a href="index.html"><h1>Resum Resume<span>.</span></h1></a>
<nav>
<ul id="nav-menu">
<li><a href="#home">Home</a></li>
<li><a href="#about.html">About Us</a></li>
<li><a href="#resume.html">Resume</a></li>
<li><a href="#signup.html">Sign Up</a></li>
<li><a href="index.html">Home</a></li>
<li><a href="about.html">About Us</a></li>
<li><a href="resume.html">Resume</a></li>
<a href="template_type.html">Resume Templates</a>
<li><a href="signup.html">Sign Up</a></li>
Comment on lines +21 to +25
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistent navigation structure.

The "Resume Templates" link breaks the list structure of the navigation menu. While other items are properly wrapped in <li> tags, this one isn't.

Apply this fix:

            <li><a href="index.html">Home</a></li>
            <li><a href="about.html">About Us</a></li>
            <li><a href="resume.html">Resume</a></li>
-           <a href="template_type.html">Resume Templates</a>
+           <li><a href="template_type.html">Resume Templates</a></li>
            <li><a href="signup.html">Sign Up</a></li>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<li><a href="index.html">Home</a></li>
<li><a href="about.html">About Us</a></li>
<li><a href="resume.html">Resume</a></li>
<a href="template_type.html">Resume Templates</a>
<li><a href="signup.html">Sign Up</a></li>
<li><a href="index.html">Home</a></li>
<li><a href="about.html">About Us</a></li>
<li><a href="resume.html">Resume</a></li>
<li><a href="template_type.html">Resume Templates</a></li>
<li><a href="signup.html">Sign Up</a></li>

<li><a href="login.html">Login</a></li>
</ul>
</nav>
Expand Down
1 change: 1 addition & 0 deletions privacypolicy.html
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ <h1>Resum Resume</h1>
<a class="tab" href="index.html">Home</a>
<a class="tab" href="about.html">About</a>
<a class="tab" href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
<a class="tab" href="signup.html">Sign Up</a>
<a class="tab" href="login.html">Login</a>
<a class="tab" href="privacypolicy.html">Privacy Policy</a>
Expand Down
2 changes: 1 addition & 1 deletion resume.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a href="#" class="logo">Resum Resume<span>.</span></a>

<nav class="navbar">
<a href="#home">Home</a>
<a href="index.html">Home</a>
<a href="about.html">About</a>
<a href="resume.html">Build Resume</a>
<a href="RateMyResume.html">RateMyResume</a>
Expand Down
1 change: 1 addition & 0 deletions resume_tips.html
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ <h1>Resum Resume</h1>
<a class="tab" href="#home">Home</a>
<a class="tab" href="about.html">About</a>
<a class="tab" href="resume.html">Build Resume</a>
<a href="template_type.html">Resume Templates</a>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add ARIA labels and improve accessibility.

Several accessibility issues need to be addressed:

  1. Navigation links lack proper ARIA labels
  2. Social media icons need descriptive text for screen readers
  3. Progress bar needs ARIA attributes

Apply these accessibility improvements:

- <nav class="navbar">
+ <nav class="navbar" aria-label="Main navigation">
-    <img src="images/logo.png" alt="logo">
+    <img src="images/logo.png" alt="Resum Resume logo">

- <div id="progress-container">
-     <div id="progress-bar"></div>
+ <div id="progress-container" role="progressbar" aria-label="Reading progress">
+     <div id="progress-bar" aria-valuenow="0" aria-valuemin="0" aria-valuemax="100"></div>

- <a href="#"><i class="fab fa-facebook-f"></i></a>
+ <a href="#" aria-label="Visit our Facebook page"><i class="fab fa-facebook-f"></i></a>

Update the progress bar script to maintain accessibility:

function updateProgressBar() {
    // ... existing code ...
    progressBar.setAttribute('aria-valuenow', Math.round(lastScrollPercentage));
}

Also applies to: 1-600


⚠️ Potential issue

Fix navigation structure and inconsistencies.

While the new Resume Templates link is correctly added, there are several structural issues in the navigation:

  1. The navbar contains nested <nav> elements, which is invalid HTML
  2. The empty tabs-container div serves no purpose
  3. Inconsistent usage of the "tab" class across navigation links

Apply this diff to fix the navigation structure:

-    <nav class="navbar">
-        <div class="tabs-container"></div>
-        <a class="tab" href="#home">Home</a>
-        <a class="tab" href="about.html">About</a>
-        <a class="tab" href="resume.html">Build Resume</a>
-        <a href="template_type.html">Resume Templates</a>
-        <a class="tab" href="resume_tips.html">Resume Tips</a>
-        <a class="tab" href="signup.html">Sign Up</a>
-        <a class="tab" href="login.html">Login</a>
-        </div>
-    </nav>
+    <div class="nav-links">
+        <a class="tab" href="#home">Home</a>
+        <a class="tab" href="about.html">About</a>
+        <a class="tab" href="resume.html">Build Resume</a>
+        <a class="tab" href="template_type.html">Resume Templates</a>
+        <a class="tab" href="resume_tips.html">Resume Tips</a>
+        <a class="tab" href="signup.html">Sign Up</a>
+        <a class="tab" href="login.html">Login</a>
+    </div>

Committable suggestion skipped: line range outside the PR's diff.

<a class="tab" href="resume_tips.html">Resume Tips</a>
<a class="tab" href="signup.html">Sign Up</a>
<a class="tab" href="login.html">Login</a>
Expand Down
1 change: 1 addition & 0 deletions signup.html
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@ <h1> Resume</h1>
<li><a href="index.html">Home</a></li>
<li><a href="about.html">About</a></li>
<li><a href="resume.html">Build Resume</a></li>
<a href="template_type.html">Resume Templates</a>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistent navigation structure.

The "Resume Templates" link is not wrapped in an <li> tag, unlike other navigation items. This breaks the consistent structure and styling of the navigation bar.

Apply this fix:

-            <a href="template_type.html">Resume Templates</a>
+            <li><a href="template_type.html">Resume Templates</a></li>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<a href="template_type.html">Resume Templates</a>
<li><a href="template_type.html">Resume Templates</a></li>

<li><a href="signup.html">Sign Up</a></li>
<li><a href="login.html">Login</a></li>
</ul>
Expand Down
Loading