Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

Commit

Permalink
Clean up the readme file, remove redundant sleep instruction (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
kgapos authored Nov 2, 2023
1 parent 654aa85 commit 6900ce5
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
14 changes: 3 additions & 11 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,16 @@ If a community member engages in unacceptable behavior, the community organizers

## 5. Reporting Guidelines

If you are subject to or witness unacceptable behavior, or have any other concerns, please [contact us](#8-contact-information) as soon as possible.
If you are subject to or witness unacceptable behavior, or have any other concerns, please [contact us](README.md/#contact-information) as soon as possible.

## 6. Addressing Grievances

If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should [contact us](#8-contact-information) with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should [contact us](README.md/#contact-information) with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.

## 7. Scope

We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.

## 8. Contact Information

* Project maintainer [email protected]
* Project maintainer [email protected]
* Main contributor [email protected]
* Discord https://discord.com/invite/vechain #support
* Support https://support.vechain.org

## 9. License and Attribution
## 8. License and Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct/.
53 changes: 31 additions & 22 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The API contains two endpoints:

used by Prometheus to collect health metrics, such as the last block timestamp, number of seconds since last block and node health status.

![Node Hosting Design Diagram - Healthcheck](images/architecture-diagram-healthcheck.webp)
![Node Hosting Design Diagram - Healthcheck](images/architecture-diagram-healthcheck.png)

## Table of Contents

Expand All @@ -33,11 +33,12 @@ The API contains two endpoints:
- [Using Node](#using-node)
- [Using Docker](#using-docker)
- [Release new docker image](#release-new-docker-image)
- [Contributing](#contributing)
- [Roadmap](#roadmap)
- [Changelog](#changelog)
- [License](#license)
- [Credits](#credits)
- [Contributing](#contributing)
- [Roadmap](#roadmap)
- [Changelog](#changelog)
- [License](#license)
- [Contact Information](#contact-information)
- [Credits](#credits)

## Getting Started

Expand Down Expand Up @@ -71,19 +72,19 @@ npm start

### Using Docker

To build and run the image with docker, run the following commands in the root directory of the project:

The following bash scripts are available to help you build, run and test the app locally with docker:
```bash
docker build . -t node-healthcheck:dev
docker run -d \
--name node-hc \
-p 11012:11012 \
-e NODE_URL=https://mainnet.vechain.org \
node-healthcheck:dev
cd scripts
./clean.sh
./build.sh
./run.sh
./test.sh

# or simply
./all.sh
```

To download and run the image with docker:

To download and run the image with docker without building it:
```bash
docker run -d \
--name node-hc \
Expand All @@ -104,26 +105,34 @@ To release a new version of the exporter, follow these steps:
3. Run `./release.sh <version>` to build and push the image to ECR, where `<version>` is the tag for the new image.
4. Verify that the new release was correctly pushed to [the docker repository](https://gallery.ecr.aws/vechainfoundation/node-healthcheck).

### Contributing
## Contributing

If you want to contribute to this project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

For more details and guidelines on how to contribute, refer to [CONTRIBUTING](CONTRIBUTING.md).

### Roadmap
## Roadmap

We are planning to add more features to this application going forward. More details to follow and suggestions are always welcome in the form of [GitHub issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue).

### Changelog
## Changelog

- v1 [31-Mar-2023] Add prometheus metrics for node health
- v0 [08-Feb-2023] Implement a basic healthcheck API for nodes, based on block timestamps

### License
## License

This project is licensed under [the MIT license](LICENSE.md).

### Credits
## Contact Information

* Project maintainer Kostas Apostolopoulos ([@kgapos](https://github.com/kgapos)) - [email protected]
* Project maintainer Rishi Pal ([@rishikeshpal](https://github.com/rishikeshpal)) - [email protected]
* Main contributor Fabio Rigamonti ([@fabiorigam](https://github.com/fabiorigam)) - [email protected]
* Discord https://discord.com/invite/vechain #support
* Support https://support.vechain.org

## Credits

Special recognition to the main contributors:
- @fabiorigam
- [Fabio Rigamonti (@fabiorigam)](https://github.com/fabiorigam)
1 change: 0 additions & 1 deletion scripts/all.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ cd $scripts_path
./clean.sh
./build.sh
./run.sh
sleep 1
./test.sh

0 comments on commit 6900ce5

Please sign in to comment.