Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 2.97 KB

README.md

File metadata and controls

93 lines (61 loc) · 2.97 KB
Raw

IHR Website

The Internet Health Report monitors the conditions of networks that compose the Internet. This effort aims to provide network operators, policymakers, and other stakeholders, with a better understanding of the Internet's infrastructure and its evolution. To understand further click here

Prerequisites to run

Install Node JS

Refer to https://nodejs.org/en/ to install nodejs

Install npm package manager

Refer to https://docs.npmjs.com/cli/v6/configuring-npm to install npm

Cloning and Running the Application in local

Clone the project in localhost

git clone https://github.com/InternetHealthReport/ihr-website.git
cd ihr-website

Note:

  • Currently the project supports node --version =< 16.9.1
  • you can use nvm to switch between node versions as per your need

Install all the npm packages. Go to root directory and type the following command to install all npm packages

npm install

For compilations and hot-reloads in development

npm run serve

To compile and minify for production run

npm run build

To run your tests

npm run test

To lints and fixes files

npm run lint

To run your unit tests

npm run test:unit

Customize configuration

See Configuration Reference test

Set up

Check out our installation video here for a step-by-step guide on how to install and set up our software

Ways to contribute

First off, thanks for taking the time to contribute! 🎉🎉

When contributing to this repository, please first discuss the change you wish to make via issue with the maintainers of this repository before making a change. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

  1. Solve the issues which are listed
  2. Create your own issue and then send PR.

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow. The basic workflow:

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Create a branch and name it with the issue number
  4. Commit changes to the branch
  5. Push your work back to your fork
  6. Rebase your branch with the master branch
  7. Submit your Pull Request so that we can review it

Please submit your issues and pull request while following the automated template. During the contributing phase abide by the Contributing Guidelines and Code of Conduct.