Hire Me - Full Stack Job Portal

Table of Contents

• About the Project
• Features
• Tech Stack
• Installation
• Environment Variables
• Usage
• Deployment
• Contributing
• License
• Contact

About the Project

Hire Me is a full-stack job portal where job seekers can search and apply for job openings, upload their resumes, and manage their profiles. Recruiters can post jobs, manage applications, and accept/reject candidates. The platform uses Clerk for authentication and Sentry for error tracking and performance monitoring.

Features

• 🏢 Job Seekers:

  • Search and apply for jobs
  • Upload and manage resumes
  • View application status

• 🎯 Recruiters:

  • Post and manage job listings
  • View, accept, or reject job applications
  • Access applicant resumes

• 🔧 Additional Features:

  • User authentication via Clerk
  • Sentry integration for performance monitoring
  • MongoDB query optimization using Sentry
  • Full deployment on Vercel

Tech Stack

• Frontend: React, Tailwind CSS
• Backend: Node.js, Express.js
• Database: MongoDB
• Authentication: Clerk
• Monitoring: Sentry
• Deployment: Vercel

Installation

1. Clone the repository:

   git clone https://github.com/TuShArBhArDwA/HireMe.git
   cd HireMe

2. Install dependencies

   npm install

3. Set up environment variables

• Create a .env file in the root directory.
• Add the required environment variables (see Environment Variables).

4. Start the development server

   npm run dev

• The application will be available at http://localhost:3000.

Environment Variables

• To run this project, you need to set up the following environment variables. Create a .env file in the root directory and add:

  MONGODB_URI=your_mongodb_connection_string
  CLERK_API_KEY=your_clerk_api_key
  SENTRY_DSN=your_sentry_dsn
  VERCEL_URL=your_vercel_project_url

Configuration Instructions:

• MONGODB_URI → Your MongoDB connection string from MongoDB Atlas or a self-hosted MongoDB instance.
• CLERK_API_KEY → Your API key from Clerk for user authentication.
• SENTRY_DSN → Your Data Source Name (DSN) from Sentry for error tracking and performance monitoring.
• VERCEL_URL → Your Vercel deployment URL (optional for production setups).
  Note: Never expose your environment variables in public repositories. Use .env files locally and configure them securely in deployment environments.

Usage

1. Run the development server

   npm run dev

• The application will be available at http://localhost:3000.

2. Sign up or log in

• Job Seekers:
  • Search and apply for jobs.
  • Upload and manage resumes.
  • Track application status.
• Recruiters:
  • Post and manage job listings.
  • View, accept, or reject applications.
  • Access applicant resumes.

3. Manage applications

• Recruiters can accept or reject applications.
• Job seekers can track the status of their applications.

4. Monitor performance (Admins/Developers)

• Use Sentry to track errors and optimize MongoDB queries.

Deployment

• The project is deployed on Vercel for seamless hosting.

• To deploy the frontend and backend, use the following command:

  vercel

• Ensure your Vercel CLI is installed and logged in before running the command.

• Configure environment variables on Vercel to match your local .env file.

• After deployment, access the live application via the provided Vercel URL.

Contributing

Contributions are welcome! If you'd like to contribute, follow these steps:

1. Fork the repository
   Click the "Fork" button on the top-right corner of the repository page.
2. Clone your forked repository

   git clone https://github.com/TuShArBhArDwA/HireMe.git
   cd HireMe

3. Create a new branch

   git checkout -b feature-name

4. Make your changes and commit them

   git add .
   git commit -m "Add feature: description of changes"

5. Push your changes to your forked repository

   git push origin feature-name

6. Create a Pull Request (PR)

• Go to the original repository on GitHub.
• Click on "Compare & pull request."
• Add a meaningful title and description.
• Submit the PR for review.

Guidelines

• Follow best coding practices.
• Write clear and concise commit messages.
• Ensure the code is properly formatted and linted.
• Test your changes before submitting a PR.

License

• This project is licensed under the MIT License.

Contact

• Meet T-Bot - Discover My Work
• Tushar Bhardwaj - Portfolio
• Connect 1:1 - Topmate
• GitHub: TuShArBhArDwA
• LinkedIn: Tushar Bhardwaj
• Email: tusharbhardwaj2617@gmail.com