https://github.com/encoreshao/puppeteer-typescript-starter

The most basic Puppeteer TypeScript starter
https://github.com/encoreshao/puppeteer-typescript-starter

data-scraper json nodemon puppeteer structure typescript

Last synced: 25 days ago
JSON representation

The most basic Puppeteer TypeScript starter

• Host: GitHub
• URL: https://github.com/encoreshao/puppeteer-typescript-starter
• Owner: encoreshao
• Created: 2022-10-03T02:14:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-03T02:24:21.000Z (about 2 years ago)
• Last Synced: 2024-10-04T04:21:45.961Z (about 1 month ago)
• Topics: data-scraper, json, nodemon, puppeteer, structure, typescript
• Homepage:
• Size: 2.93 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple Puppeteer TypeScript Starter | 2022

This template will quickly help us build a project using Puppeteer and TypeScript for data scraping in public pages.

### Features

- Minimal

- TypeScript V4

- Testing with Jest

- Linting with Eslint and Prettier

- Local development with Nodemon

- IP Proxy

### Structure

```

  build

    └── index.js

    └── ...

  config

    └── config.json

  src

    └── pages

        ├── index.ts

        ├── identifiers.ts

        ├── userTemplate.ts

    └── environment

        ├── config.ts

    └── utils

        ├── index.ts

    └── index.ts

  types

    └── index.d.ts

```

### Scripts Overview

```NodeJS

npm run start:dev

```

Starts the application in development using nodemon and ts-node to do cold reloading.

```NodeJS

npm run build

```

Builds the app at build, cleaning the folder first.

```NodeJS

npm run start

```

Starts the app in production by first building the project with `npm run build`, and then executing the compiled JavaScript at `build/index.js`.