Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2.65 KB

README.md

File metadata and controls

76 lines (48 loc) · 2.65 KB
Raw

Charizard 🔥🔥 Awesome OpenSooq logo



Introduction

automated tool for improving the quality of web pages running on Node.js and MongoDb and Google Page Speed API. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, SEO and more.

Architecture

Charizard communicated with Google lighthouse to get the score of web then we save it in MongoDb to build the reporting for the future. This digaram demeonstrates the high level cummincation between modules.

Features

  • Analyze the load speed of your Mobile, Desktop platforms.
  • Add urls to be monitored.
  • Dashboard with history for load speed to each url you added.

Getting Started

Installing steps

  • Install nodejs and mongoDb

  • Create new directory for your charizard and navigate to it, clone the repo and run the npm install command:

     $ npm install

  • to setup mongodb run the command:

      $ npm run setup

  • add the following command to your cron job list to be running every day to fetch the page load speed results for your urls:

      $ npm run cron

  • Note: To override the configuration, you can create .env file and add to it the environment variables.

  • to start the porject run web command:

      $ npm run web

  • The defualt url will be http://localhost:3000/ . By following above steps you will be running your own charizard. You are welcome to contribute with us or getting an imporvement to make it live.

License

Copyright 2019 OpenSooq

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.