Skip to content

Latest commit

 

History

History
138 lines (88 loc) · 4.55 KB

README.md

File metadata and controls

138 lines (88 loc) · 4.55 KB

ExRx Net Crawler Feature Graphics

GitHub release Build Status GitHub issues GitHub forks GitHub stars GitHub license Twitter

ExRx.net Crawler

ExRx.net Crawler ExRx.net Crawler is a Vue based crawling project for ExRx.net.

Official Docker Image

Features

Here is the highlights of ExRx.net Crawler:

  1. Parse DOM, marge DOM nodes.
  2. Axios, support CORS.
  3. Communicate with back-end server.
  4. Based on the most modern and latest TypeScript - npm version
  5. Material components demo.
  6. Docker support.
  7. Multi-environment support, multi-lingual (internationalisation).
  8. NGINX Gzip support.
  9. Support Dark / Light color scheme. Self-adaptive color scheme change.
  10. Lazy router.
  11. Beatified noscript content.

Roadmap

Usage

Project Setup

Recommended IDE is the latest version JetBrains WebStorm.

  1. Clone or download this project.

    $ git clone https://github.com/johnnymillergh/exrx-net-crawler.git
  2. Project setup.

    npm install

Compiles and Hot-reloads for Development

npm run serve

Compiles and Minifies for Production

npm run build

Run Your Unit Tests

npm run test:unit

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Docker Integration

Docker deployment can defer by environment. Here is the list of environments:

# Environment Name Environment Alias Name Description
1 development_docker dev_dkr
2 test test
3 stage stage
4 production prod

The Procedures of Docker Deployment

  1. Compile and minify source (can be deferred by environment, if it’s development_docker, then the command could be npm run build:dev_dkr)

    npm run build
  2. Build Docker image and run by Docker Compose. Available Docker Compose:

    • development_docker
    • test
    • stage
    • production

Maintainers

@johnnymillergh.

Contributing

Feel free to dive in! Open an issue.

Contributors

This project exists thanks to all the people who contribute.

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Apache License © Johnny Miller

2020 - Present