Skip to content

docs: replace boilerplate README with project-specific documentation - #1

Merged
Brunoiooo merged 1 commit into
mainfrom
copilot/add-good-readme
Jul 8, 2026
Merged

docs: replace boilerplate README with project-specific documentation#1
Brunoiooo merged 1 commit into
mainfrom
copilot/add-good-readme

Conversation

Copilot AI commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

The README was the default create-next-app template — useless for anyone trying to understand or run the project.

Changes

  • Overview: describes the project as an AI-powered Useme job application pipeline
  • Tech stack: table covering Next.js 15, PrimeReact, Prisma/PostgreSQL, OpenAI, Puppeteer
  • Setup: env var reference (all variables from .env.example documented), DB migration steps
  • Usage: explains each dashboard action (Scrap → Verify → Generate → Send) and the /prompts page
  • Project structure: annotated directory tree mapping actions/, services/, components/
  • Scripts & schema: quick-ref for npm scripts and Prisma models

@Brunoiooo
Brunoiooo marked this pull request as ready for review July 8, 2026 12:17
Copilot AI review requested due to automatic review settings July 8, 2026 12:17
@Brunoiooo
Brunoiooo merged commit 2c75f3a into main Jul 8, 2026
1 check passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Replaces the default create-next-app README with project-specific documentation describing “Job Finder” (an AI-assisted Useme job application pipeline), how to configure it, and how to operate the dashboard.

Changes:

  • Adds a project overview, feature list, and tech stack summary.
  • Documents environment variables and initial setup steps (including Prisma/DB setup).
  • Explains dashboard workflow, project structure, scripts, and Prisma models at a high level.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

## Features

- **Scrape** job listings from Useme based on configured categories and filters
Comment thread README.md
### 3. Set up the database

```bash
npx prisma migrate deploy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants