README.md

SITE CHROMEUX (CrUX) REPORT

Web application to search the CrUX data from Google BigQuery API for multiple websites

Tech Stack

• React Frontend + TypeScript
• Node.js Backend

Other Tools

• Axios for client side api handling
• Express for Backend api route hanlding
• Bootstrap for styling on the Frontend
• nodejs-bigquery library for managing query requests to BigQuery Database

Instructions To Configure

• Clone the project using git clone <repo_url> command
• run cd client && touch .env && cd ..
• run cd server && touch .env && cd ..
• under client/.env add the following key REACT_APP_API_BASE_URL="http://localhost:4000"
• under server/.env add the following key GCP_PROJECT_ID=<your gcp project id>
• Download service account credentials from gcp and save it under server/big-query.json. Refer here for more
• run cd client && yarn install && yarn start && cd .. to run client on http://localhost:3000
• run cd server && yarn install && yarn start && cd .. to run server on http://localhost:4000

Functionalities

Part 1

• Search CrUX data for a url
• Tabular data of the result

Part 2

• Sorting on data fields and you can set the sorting by clicking/toggling on any data fields
• Filter data by enabling/disabling certain metrics from the table to view only particular data

Part 3

• Support CrUX data for multiple urls searching

Screenshots