Skip to content

Latest commit

 

History

History
127 lines (79 loc) · 4.18 KB

README.md

File metadata and controls

127 lines (79 loc) · 4.18 KB
Raw

Bottable.Io

Apps

Extension

  • Web Extension

Web

  • NextJS

Server

  • Graphql server

Task

Background worker listens to task queue Run I/O blocking tasks:

  • Sync: run scheduled task to sync the db with scraper queues
    • TODO queue sync should be applicable to task queues as well
  • Slack: notify via slack => api-wrapper-util-slack
  • Email: notfiy via email => api-wrapper-util-mail
  • Ping: aliveness

Scraper

  • Received Scraper job from scraper queue
  • Upon triggering the scraper job, it will launch puppeteer to fetch those values on the page (it will try up to 10 times to wait for the elements to appear on page)
  • Push result to processor queue if successful

Processor

  • Recieve, process, and store value from from processor queue

Subscriber

  • Subscribe to queue events (failed, completed..etc) and trigger corresponding handler Handlers:
    • Scraper: TODO notify Slack on failure

Monitor (Admin)

  • Monitor queue job and status
  • TODO add Prisma and graphql playground

This project was generated using Nx.

🔎 Nx is a set of Extensible Dev Tools for Monorepos.

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • React
    • npm install --save-dev @nrwl/react
  • Web (no framework frontends)
    • npm install --save-dev @nrwl/web
  • Angular
    • npm install --save-dev @nrwl/angular
  • Nest
    • npm install --save-dev @nrwl/nest
  • Express
    • npm install --save-dev @nrwl/express
  • Node
    • npm install --save-dev @nrwl/node

There are also many community plugins you could add.

Generate an application

Run nx g @nrwl/react:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run nx g @nrwl/react:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are sharable across libraries and applications. They can be imported from @bottable.io/mylib.

Development server

Run nx serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run nx g @nrwl/react:component my-component --project=my-app to generate a new component.

Build

Run nx build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run nx test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx dep-graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.

☁ Nx Cloud

Computation Memoization in the Cloud

Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.

Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.

Visit Nx Cloud to learn more.