Namit2111 / Linkedin-to-resume

Other
1 stars 1 forks source link
hacktoberfest linkedin portfolio resume

Project README

Project Overview

This is a full-stack project built using Flask as the backend framework and Next.js for the frontend. The project integrates with the LinkedIn API to fetch user profile data and display it on a portfolio page. It allows users to input a LinkedIn profile URL, retrieves the relevant profile data, and displays it in a well-structured portfolio format.

The backend uses Flask and the linkedin-api library to interact with LinkedIn, while the frontend is built using Next.js to provide a responsive UI displaying the fetched data, such as personal details, experience, education, projects, skills, and certifications.


Features


Project Structure


Requirements

Backend

Frontend


Setup Instructions

Backend Setup (Flask)

  1. Clone the repository:

    git clone https://github.com/Namit2111/Linkedin-to-resume
    cd backend
  2. Create a virtual environment:

    It is recommended to use a virtual environment to manage dependencies.

    python3 -m venv venv
    source venv/bin/activate   # On Windows: venv\Scripts\activate
  3. Install dependencies:

    Use the requirements.txt file to install all required libraries.

    pip install -r requirements.txt
  4. Configure LinkedIn API credentials:

    Ensure you have your LinkedIn username and password configured in the config/config.py file:

    l_username = "your_linkedin_username"
    l_pass = "your_linkedin_password"
  5. Run the Flask server:

    flask run

    The server will be running at http://127.0.0.1:5000/.

Frontend Setup (Next.js)

  1. Navigate to the frontend directory:

    cd ../frontend
  2. Install Node.js dependencies:

    Make sure you have Node.js installed. Then install the required dependencies using npm or yarn:

    npm install

    or

    yarn install
  3. Run the development server:

    After installing the dependencies, start the Next.js development server:

    npm run dev

    This will start the frontend at http://localhost:3000.


How the Project Works

Running Both Frontend and Backend

After setting up both the backend and frontend, you can run them concurrently:

  1. Start the Flask backend:

    cd backend
    flask run
  2. In another terminal, start the Next.js frontend:

    cd frontend
    npm run dev

You can now access the frontend via http://localhost:3000 and interact with the backend API to fetch and display LinkedIn profile data.