Got it! Here's a polished and professional version of your README.md for the job-information-crawler project. I've improved clarity, structure, and consistency while preserving your original intent:
job-information-crawler is a Node.js-based web automation tool for scraping job listings from LinkedIn and Seek. It automates the job search process and exports data for further use.
- 🔍 Scrapes job information from LinkedIn and Seek
- ⚙️ Web page automation using Puppeteer
- 📁 CSV file generation using
csv-writer - 📅 Date handling with
dayjs - 🔐 Environment variable configuration support
- 💾 Optional database interaction support
- 📧 Email notification system for job updates
Requirements:
- Node.js (Latest LTS version recommended)
Clone the repository and install dependencies:
git clone https://github.com/kenjiding/job-information-crawler.git
cd job-information-crawler
npm installBefore running the project, create a .env file in the root directory and provide the required credentials:
# LinkedIn credentials
LINKEDIN_EMAIL='your_linkedin_email'
LINKEDIN_PASSWORD='your_linkedin_password'
# Seek credentials
SEEK_EMAIL='your_seek_email'
SEEK_PASSWORD='your_seek_password'
# Email sender credentials (for job alerts)
SENDER_EMAIL='sender_email'
SENDER_EMAIL_PASSWORD='sender_email_password'
SENDER_EMAIL_TARGET='target_email_to_receive_notifications'Run the crawler:
npm run startYou can customize the search behavior in ./src/index.ts:
start.linkedin(...).seek(...);
start.seek(...).linkedin(...);
start.linkedin(...);
start.seek(...);Here’s an example of the available options:
{
username: 'your_email',
password: 'your_password',
keywords: 'developer',
location: 'Adelaide',
filterAlreadyApply: true, // Optional
titleIncludes: 'engineer', // Optional
ignores: ['senior', 'manager'], // Optional
filter: {
// Add custom filter logic here
},
pages: 3 // Number of pages to search
}- Add support for more job platforms (e.g., Indeed, Glassdoor)
- Add database storage for job results
- Enhance email formatting and scheduling
- Add unit tests and error handling
MIT
如果你还想添加 Logo、运行截图或数据库使用说明也可以告诉我，我可以帮你继续完善。需要我帮你生成一个 .env.example 文件也没问题！