From a878b1e55865f98610d33cf0f5102553a1d7fbfa Mon Sep 17 00:00:00 2001 From: Priyam <104610119+priyam-03@users.noreply.github.com> Date: Sat, 17 Aug 2024 18:06:11 +0530 Subject: [PATCH] Update README.md --- README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) diff --git a/README.md b/README.md index 8b13789..5ea49ce 100644 --- a/README.md +++ b/README.md @@ -1 +1,94 @@ +# AI-Powered Recruiting Platform + +Welcome to the AI-Powered Recruiting Platform! This platform is designed to revolutionize the recruitment process by integrating AI-driven features, seamless interview management, and social networking capabilities. + +## Table of Contents +- [Features](#features) +- [Technology Stack](#technology-stack) +- [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + +## Features + +- **AI-Powered Automated Shortlisting**: Automatically shortlist candidates based on profile matching and job requirements. +- **Integrated Interview System**: Conduct virtual interviews similar to Google Meet directly within the platform. +- **Networking and Messaging**: Connect with professionals, send messages, and build your network. +- **Content Creation and Sharing**: Post updates, share professional content, and engage with the community. + +## Technology Stack + +- **Frontend**: React.js +- **Backend**: Express.js +- **Database**: MongoDB + +## Installation + +To set up the project locally, follow these steps: + +1. **Clone the repository**: + ```bash + git clone https://github.com/yourusername/recruiting-platform.git + cd recruiting-platform + ``` + +2. **Install dependencies**: + ```bash + # Install backend dependencies + cd backend + npm install + + # Install frontend dependencies + cd ../frontend + npm install + ``` + +3. **Set up environment variables**: + + Create a `.env` file in both the `backend` and `frontend` directories and add the necessary environment variables as outlined in the `.env.example` files. + +4. **Start the development servers**: + ```bash + # Start backend server + cd backend + npm run dev + + # Start frontend server + cd ../frontend + npm start + ``` + +5. **Access the platform**: + Open your browser and navigate to `http://localhost:3000` to start using the platform. + +## Usage + +- **User Authentication**: Sign up or log in to start using the platform. +- **Profile Management**: Create and manage your professional profile. +- **Job Searching**: Browse job listings and apply directly through the platform. +- **AI Shortlisting**: Let the AI help you find the best candidates or jobs. +- **Virtual Interviews**: Schedule and conduct interviews with just a few clicks. +- **Networking**: Connect with other professionals and expand your network. +- **Messaging**: Communicate with connections directly through the platform. +- **Content Creation**: Share posts and updates with your network. + +## Contributing + +We welcome contributions! To contribute: + +1. **Fork the repository**. +2. **Create a new branch** for your feature or bug fix. +3. **Commit your changes** and push to your branch. +4. **Submit a pull request** to the `main` branch. + +Please refer to the `CONTRIBUTING.md` file for more details. + +## License + +This project is licensed under the MIT License. See the `LICENSE` file for more information. + +--- + +Feel free to customize the content to match your project's specific requirements.