Skip to content

Commit 92242ce

Browse files
authored
Update README.md
1 parent b721039 commit 92242ce

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Traditional CV feedback is:
1818
PrepCheck solves this by providing instant, intelligent, personalised feedback at no cost, making professional CV analysis accessible to everyone.
1919

2020
**Try PrepCheck now - No installation required!**
21-
🔗 **Live Demo:**
21+
🔗 **Live Demo:** [PrepCheck](https://prepcheck-1.onrender.com)
2222

23-
Click the link above to start receiving personalised CV analysis! 💕🎨🌟
23+
Click the link above to start receiving personalised CV analyses! 💕🎨🌟
2424

2525

2626
## 🎨 Features
@@ -69,17 +69,17 @@ Five-Bucket Scoring System (100 points total):
6969

7070
## ⚙ How PrepCheck Works
7171

72-
1. User uploads the CV in either PDF or Word format.
72+
1. User uploads their CV in either PDF or Word format.
7373
2. Backend verifies if the file is an appropriate CV.
74-
3. Once verified- the backend sends this file to Gemini's API.
74+
3. Once passed verification- the backend sends this file to Gemini's API.
7575
4. The AI returns a personalised CV analysis.
7676
6. Users can chat to PrepPal for more information on the CV analysis.
7777

7878

7979
## 💌 Themes
8080

81-
- Light mode:
82-
- Dark mode:
81+
- Light mode: light blues and purples with black font.
82+
- Dark mode: dark blues and purples with white font.
8383

8484
## 📷 Preview
8585

@@ -143,7 +143,7 @@ Conversational AI capabilities.
143143

144144
## 🖥 How to Run
145145

146-
**Note:** PrepCheck is already live at
146+
**Note:** PrepCheck is already live at [PrepCheck](https://prepcheck-1.onrender.com)
147147
These instructions are for running the project on your local machine for development.
148148

149149
**Prerequisites**
@@ -268,25 +268,26 @@ docker push mmeligab/prepcheck-frontend:latest
268268

269269
This project is deployed using:
270270

271-
- **Frontend:** Netlify (serves static files from `frontend/` folder).
271+
- **Frontend:** Render (serves static files from `frontend/` folder).
272272
- **Backend:** Render (Node.js/Express server from `backend/` folder).
273273

274274
### Deploy Your Own Instance:
275275

276276
**Backend (Render):**
277277
1. Create an account at [Render](https://render.com/).
278278
2. New Web Service → Connect Git repo.
279-
3. Root Directory: `server`.
279+
3. Root Directory: `backend`.
280280
4. Build: `npm install`.
281281
5. Start: `npm start`.
282282
6. Add `GEMINI_API_KEY` environment variable.
283283

284-
**Frontend (Netlify):**
285-
1. Create an account at [Netlify](https://www.netlify.com/).
286-
2. Import from Git or drag the `frontend/` folder.
287-
3. Base Directory: `public`.
288-
4. Publish Directory: `public`.
289-
5. Update API URLs in JS files to point to your backend.
284+
**Frontend (Render):**
285+
1. Create an account at [Render](https://render.com/).
286+
2. New Static Site → Connect Git repo.
287+
3. Root Directory: `frontend`.
288+
4. Publish Directory: `dist`.
289+
5. Build: `npm install & npm run build`.
290+
6. Add `VITE_APP_URL` with backend Render URL environment variable.
290291

291292

292293
## 📂 API Documentation
@@ -308,9 +309,8 @@ GET /api/health
308309
**Response:**
309310

310311
```json
311-
{
312-
"status": "ok",
313-
"timestamp": "2025-11-22T10:30:00.000Z"
312+
{
313+
"status”:“ok”,“message”:“Server is running!”
314314
}
315315
```
316316

0 commit comments

Comments
 (0)