Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 3.26 KB

README.md

File metadata and controls

104 lines (69 loc) · 3.26 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

Install Node v20.10.0 (LTS)

Install npm package manager

Install Npm v10.2.4

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:

  • you can use nvm to switch between node versions as per your need

Install all the npm packages.

npm install

For compilations and hot-reloads in development

npm run dev

To compile and minify for production run

npm run build

To lints and fixes files

npm run lint

To format files

npm run format

Deploy with Docker

To deploy the project with Docker, follow these steps:

Clone the project in localhost

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

Build the Docker Image

docker build -t ihr-website .

Run the Docker Container

docker run --name ihr-website -d -p <host-port>:80 -t ihr-website

Replace <host-port> with the port on your host machine where you want to expose the application.

Ways to contribute

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

Before you start, please follow these guidelines:

  1. Solve Existing Issues: If you find an existing issue that you would like to work on, please discuss it with the maintainers before starting to solve it. This ensures that everyone is on the same page regarding the approach and scope of the solution.
  2. Create a New Issue: If you have an idea for a new feature or have identified a bug that is not listed, please discuss it with the maintainers before creating a new issue. Providing context and details will help us understand the importance of your suggestion.
  3. Pull Requests (PRs): Please note that PRs that are not assigned to contributors and are not related to an open issue will be closed automatically.

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 dev 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.