The ai-resume-parser project is a software solution that enables the parsing of resumes using AI.
Before executing the project, please ensure that you have the following prerequisites installed:
- Python 3.10+ version
To set up the project, follow these steps:
- Navigate to the frontend folder and run the following command to install the necessary dependencies:
npm install
-
Create a virtual environment named
.venv
in the api_backend folder and activate it. -
Run the following command to install the required Python packages:
pip install -r requirements.txt
To run the project, follow these steps:
-
Execute the
run_frontend.bat
file to start the React frontend UI. It will be accessible atlocalhost:3001
. -
Execute the
run_backend.bat
file to start the backend API.
Once the project is up and running, you can use it as follows:
-
Access the React frontend UI at
localhost:3001
in your web browser. -
Specify the folder URL that contains the resumes you want to parse.
-
Select the desired output file format, either CSV or JSON.
-
Click the "Start" button to initiate the parsing process.
-
Once the parsing is complete, the parsed result will be stored in the
api/backend/output
folder as eitherdata.csv
ordata.json
, depending on the chosen output format.
Contributions are welcome! If you would like to contribute to the project, please follow these steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix.
-
Make the necessary changes and commit them.
-
Push your changes to your forked repository.
-
Submit a pull request, describing your changes in detail.
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions, issues, or suggestions regarding the ai-resume-parser project, please feel free to contact us.