-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |