Skip to content

Commit

Permalink
update script names and build step names
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholascus committed Jan 4, 2024
1 parent 1d4d1f8 commit 992fc86
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 40 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ jobs:
node-version: '18'
- run: yarn
- run: yarn test
e2e:
runs-on: ubuntu-latest
name: Run end-to-end tests
needs: [test]
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v4
with:
node-version: '18'
- run: yarn
- run: yarn playwright install chromium
- run: yarn playwright install-deps chromium
- run: yarn mongo
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@

## Description
This is a lightweight extendable tool which connects to your desktop browser session, and as you browse though the content it extracts and backups data following the logic defined in the parsers.

Parsers are developed with TypeScript and utilise Playwright library for access to the web session over DevTools protocol.

Currently two parsers are available, one for Twitter feeds and one for LinkedIn job collections.

## Installation

```bash
Expand All @@ -16,7 +19,7 @@ yarn mongo
# start your desktop browser with DevTools listening to local connections
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
# start web recorder
yarn pwb
yarn wr
```

...more detailed documentation is coming soon.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"typescript": "^5.3.3"
},
"scripts": {
"pwb": "ts-node src/start-playwright.ts",
"wr": "ts-node src/web-recorder.ts",
"lint": "eslint --ignore-path .eslintignore --ext .js,.ts",
"format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json|yaml|yml)\"",
"mongo": "MONGODB_VERSION=6.0-ubi8; docker run --name mongodb -d -p 27017:27017 -v $(pwd)/data:/data/db mongodb/mongodb-community-server:$MONGODB_VERSION",
Expand Down
38 changes: 0 additions & 38 deletions src/start-playwright.ts

This file was deleted.

4 changes: 4 additions & 0 deletions src/web-recorder.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { Bootstrap } from './engine/Bootstrap';
(async () => {
await new Bootstrap().run();
})();

0 comments on commit 992fc86

Please sign in to comment.