Here's an updated README file to reflect your setup without Docker Compose and with a Node.js backend:
This ATS (Applicant Tracking System) Resume Scanner uses AI to help users optimize their resumes for specific job descriptions. The app scores resumes, provides ATS-friendliness feedback, and offers bias removal suggestions, enhancing the overall resume quality.
- Customized Resume Scoring: Evaluates resumes based on the job description.
- ATS-Friendliness Feedback: Identifies resume elements that may affect automated scanning.
- AI-Powered Enhancements: Offers improvement suggestions to boost resume quality.
- Bias Detection and Removal: Assesses and removes potential bias in the resume.
- Frontend: React (built with Vite)
- Backend: Node.js with AI integration (OpenAI)
- Dockerized: Separate Docker files for frontend and backend
- frontend/ - Contains the React frontend code.
- backend/ - Contains the Node.js backend code.
- Dockerfile - Separate Dockerfiles for both frontend and backend.
- Docker installed on your machine.
git clone https://github.com/yourusername/ATS-Resume-Scanner.git
cd ATS-Resume-Scanner-
Navigate to the backend directory:
cd backend -
Build the Docker image for the backend:
docker build -t ats-backend . -
Run the backend container:
docker run -d -p 8000:8000 ats-backend
This starts the backend server on port 8000.
-
Open a new terminal and navigate to the frontend directory:
cd frontend -
Build the Docker image for the frontend:
docker build -t ats-frontend . -
Run the frontend container:
docker run -d -p 3000:3000 ats-frontend
This starts the frontend on port 3000.
Once both containers are up and running, access the application at:
- Frontend (React UI): http://localhost:3000
- Backend (Node.js API): http://localhost:8000
To stop the containers, use:
docker stop <container_id>You can find the container IDs with:
docker ps- Environment Variables: Ensure to set any required environment variables in the
.envfiles for both frontend and backend. - AI Integration: The backend requires an OpenAI API key for resume scoring and suggestions. Be sure to configure this in the backend environment settings.