/ReadMe-HireMe

CYF Glasgow 06 Final Project Team 4

Primary LanguageJavaScript

HireMe - Simplifying Job Search and Mentorship for Code Your Future Graduates

Table of Contents

About

HireMe is a platform designed to transform the job search and mentorship experience for Code Your Future graduates and trainees. Our goal is to create an all-in-one hub where graduates can effortlessly showcase their skills and projects, mentors can monitor trainee progress, and recruiters can easily find the perfect match for their job openings.

Key Features

  • Real-time GitHub Data: Profiles are automatically populated with real-time GitHub data.
  • Powerful Search: Utilise advanced search and filter options to find ideal candidates.
  • Mentorship Tracking: Mentors can keep track of trainee activities at a glance.

Technologies Used

HireMe is built using the following technologies:

  • React
  • Node.js
  • PostgreSQL

Installation

Local Setup

  1. Clone the repository: 
    
git clone https://github.com/Muath-Alawadhi/ReadMe-HireMe
  2. Navigate to the project directory: 
    
cd ReadMe-HireMe
  3. Install dependencies: 
    
npm install
  4. Deploy the PostgreSQL database using this external link: 
    
postgres://group_4:uo5oZDrdxycZtgTOVRNSCWn1e10U1rEY@dpg-ck9g7kf0vg2c738qm7ag-a.oregon-postgres.render.com/rymsn_7j8w

Usage

Local Deployment:

  • After installation, navigate to the server directory: 
    
 cd server
    Start the server by running: 
    
 node server
    You should see the message: "Server is running on port 8000."
  • Then, navigate to the client directory: 
    
 cd client
    Start the client application with: 
    
 npm start
    Open your browser and go to http://localhost:3000.

Deployed Version:

Simply visit the deployed website URL.

Upcoming Features

We have exciting features in the pipeline for future enhancements, including:

  • Adding a placeholder to indicate graduates are ready and available for work.
  • Allowing users to edit and update their profiles.
  • Implementing dynamic database updates.
  • Expanding the search bar with more filters, such as location and work preferences.

Contribute

To contribute to this project, please fork the repository and submit a pull request.

Contact

Have questions or suggestions? Feel free to contact us at: