Skip to content

Commit a878b1e

Browse files
authored
Update README.md
1 parent 5476a04 commit a878b1e

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

README.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,94 @@
11

2+
# AI-Powered Recruiting Platform
3+
4+
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.
5+
6+
## Table of Contents
7+
- [Features](#features)
8+
- [Technology Stack](#technology-stack)
9+
- [Installation](#installation)
10+
- [Usage](#usage)
11+
- [Contributing](#contributing)
12+
- [License](#license)
13+
14+
## Features
15+
16+
- **AI-Powered Automated Shortlisting**: Automatically shortlist candidates based on profile matching and job requirements.
17+
- **Integrated Interview System**: Conduct virtual interviews similar to Google Meet directly within the platform.
18+
- **Networking and Messaging**: Connect with professionals, send messages, and build your network.
19+
- **Content Creation and Sharing**: Post updates, share professional content, and engage with the community.
20+
21+
## Technology Stack
22+
23+
- **Frontend**: React.js
24+
- **Backend**: Express.js
25+
- **Database**: MongoDB
26+
27+
## Installation
28+
29+
To set up the project locally, follow these steps:
30+
31+
1. **Clone the repository**:
32+
```bash
33+
git clone https://github.com/yourusername/recruiting-platform.git
34+
cd recruiting-platform
35+
```
36+
37+
2. **Install dependencies**:
38+
```bash
39+
# Install backend dependencies
40+
cd backend
41+
npm install
42+
43+
# Install frontend dependencies
44+
cd ../frontend
45+
npm install
46+
```
47+
48+
3. **Set up environment variables**:
49+
50+
Create a `.env` file in both the `backend` and `frontend` directories and add the necessary environment variables as outlined in the `.env.example` files.
51+
52+
4. **Start the development servers**:
53+
```bash
54+
# Start backend server
55+
cd backend
56+
npm run dev
57+
58+
# Start frontend server
59+
cd ../frontend
60+
npm start
61+
```
62+
63+
5. **Access the platform**:
64+
Open your browser and navigate to `http://localhost:3000` to start using the platform.
65+
66+
## Usage
67+
68+
- **User Authentication**: Sign up or log in to start using the platform.
69+
- **Profile Management**: Create and manage your professional profile.
70+
- **Job Searching**: Browse job listings and apply directly through the platform.
71+
- **AI Shortlisting**: Let the AI help you find the best candidates or jobs.
72+
- **Virtual Interviews**: Schedule and conduct interviews with just a few clicks.
73+
- **Networking**: Connect with other professionals and expand your network.
74+
- **Messaging**: Communicate with connections directly through the platform.
75+
- **Content Creation**: Share posts and updates with your network.
76+
77+
## Contributing
78+
79+
We welcome contributions! To contribute:
80+
81+
1. **Fork the repository**.
82+
2. **Create a new branch** for your feature or bug fix.
83+
3. **Commit your changes** and push to your branch.
84+
4. **Submit a pull request** to the `main` branch.
85+
86+
Please refer to the `CONTRIBUTING.md` file for more details.
87+
88+
## License
89+
90+
This project is licensed under the MIT License. See the `LICENSE` file for more information.
91+
92+
---
93+
94+
Feel free to customize the content to match your project's specific requirements.

0 commit comments

Comments
 (0)