- Make a virtual environment using the command
python3 -m virtualenv env
- Activate the virtual environment
. env/bin/activate
- Install the dependencies using
pip install -r requirements.txt
. Run it within the backend folder. - Set the value of
GOOGLE_API_KEY
in the .env file and then source it usingsource .env
- Go to the backend code folder
cd backend/crux
- Start the development server using
python manage.py runserver
.
To try the endpoint on the http://localhost:8000/metrics
url, pass any url as a get parameter and use the key as url
. It will give the metrics as JSON.
- Go into the frontend folder using
cd frontend
- Install the dependencies using
npm install
- The url
http://localhost:3000/
should automatically open, if not open it in your browser. - Try the app using single or multiple urls.
- Supports multiple urls. Add as many URLs as you want.
- Error handling for not found URLs. Once you enter an unknown URL or a URL for which there's no data, a pop is displayed in the bottom left of the screen, showing the error message.
- Select the metrices that you'd like to see. Only the metrices in the green are shown in the table below. Click on the chip to select/unselect the metrics.
- Values threater than a particular threshold feature is also implemented.
- Click on the values text in the table column to sort the values.
- Values for different websites are displayed in different tables.