Skip to content

Commit 7f6159c

Browse files
authored
Update README.md
1 parent 834ef9a commit 7f6159c

File tree

1 file changed

+117
-1
lines changed

1 file changed

+117
-1
lines changed

README.md

Lines changed: 117 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,117 @@
1-
MERN project to automate resume shortlist and taking interview.
1+
Here's a detailed `README.md` file for your AI-powered recruiting platform:
2+
3+
```markdown
4+
# AI-Powered Recruiting Platform
5+
6+
This repository contains the source code for an advanced AI-powered recruiting platform designed to modernize and streamline the hiring process. The platform integrates AI-driven candidate shortlisting, virtual interviews, professional networking, and more.
7+
8+
## Features
9+
10+
- **AI-Powered Automated Shortlisting**
11+
- Leverage AI to automatically shortlist candidates based on their profiles and job requirements.
12+
13+
- **Integrated Virtual Interview System**
14+
- Schedule and conduct interviews directly on the platform using a built-in system similar to Google Meet.
15+
16+
- **Professional Networking**
17+
- Connect with professionals, send messages, and expand your network.
18+
19+
- **Content Creation and Sharing**
20+
- Create posts, share updates, and engage with a professional community.
21+
22+
## Technology Stack
23+
24+
- **Frontend**
25+
- Built with [React](https://reactjs.org/), offering a dynamic and responsive user interface.
26+
27+
- **Backend**
28+
- Powered by [Express.js](https://expressjs.com/), providing a robust server-side architecture.
29+
30+
- **Database**
31+
- Utilizes [MongoDB](https://www.mongodb.com/), ensuring flexible and scalable data management.
32+
33+
## Getting Started
34+
35+
To get a local copy up and running, follow these simple steps.
36+
37+
### Prerequisites
38+
39+
Ensure you have the following installed:
40+
41+
- [Node.js](https://nodejs.org/) (version 14.x or later)
42+
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
43+
- [MongoDB](https://www.mongodb.com/) (local or cloud-based)
44+
45+
### Installation
46+
47+
1. Clone the repository:
48+
```bash
49+
git clone https://github.com/yourusername/recruiting-platform.git
50+
cd recruiting-platform
51+
```
52+
53+
2. Install dependencies for both the frontend and backend:
54+
```bash
55+
cd frontend
56+
npm install
57+
cd ../backend
58+
npm install
59+
```
60+
61+
3. Create a `.env` file in the `backend` directory with the following environment variables:
62+
```env
63+
MONGODB_URI=your-mongodb-uri
64+
PORT=5000
65+
JWT_SECRET=your-secret-key
66+
```
67+
68+
4. Start the development servers:
69+
- Backend:
70+
```bash
71+
cd backend
72+
npm run dev
73+
```
74+
- Frontend:
75+
```bash
76+
cd frontend
77+
npm start
78+
```
79+
80+
5. Open your browser and navigate to `http://localhost:3000` to access the platform.
81+
82+
## Usage
83+
84+
Once the platform is running, you can:
85+
86+
- Register as a user and set up your profile.
87+
- Post job openings or search for jobs.
88+
- Use AI-powered tools to shortlist candidates.
89+
- Schedule and conduct virtual interviews.
90+
- Connect with other professionals and expand your network.
91+
92+
## Contributing
93+
94+
Contributions are welcome! Please follow these steps to contribute:
95+
96+
1. Fork the repository.
97+
2. Create a new branch (`git checkout -b feature/YourFeature`).
98+
3. Commit your changes (`git commit -m 'Add some feature'`).
99+
4. Push to the branch (`git push origin feature/YourFeature`).
100+
5. Open a pull request.
101+
102+
For more details, please refer to the `CONTRIBUTING.md` file.
103+
104+
## License
105+
106+
This project is licensed under the MIT License. See the `LICENSE` file for details.
107+
108+
## Contact
109+
110+
For any inquiries or support, feel free to reach out at [your-email@example.com](mailto:your-email@example.com).
111+
112+
---
113+
114+
**Note:** Replace `yourusername`, `your-mongodb-uri`, and `your-secret-key` with your actual GitHub username, MongoDB connection string, and a secure JWT secret key, respectively.
115+
```
116+
117+
This `README.md` provides a clear overview of the project, instructions for setting it up, and guidelines for contributing. Adjust the placeholders as needed.

0 commit comments

Comments
 (0)