chore: Update readme (#6)

* Update README.md

* Create CONTRIBUTING.md

* Create CODE_OF_CONDUCT.md

* Rename LICENSE to LICENSE.md

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@aleph.im. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing to this project
+
+We would love to get your input on this project, as an open source codebase your contribution is welcome!
+
+We want to make contributing to this webpage as easy and transparent as possible.
+
+**Before opening an issue or a pull request (PR), please make sure that the feature does not already exist.**
+
+## Opening an issue
+
+Use the issue system to:
+
+- Report a bug
+- Ask for a new feature
+- Discuss the current state of the code (might be moved to the `discussion` section)
+
+When reporting a bug, make sure to include every detail that could help reproduce the issue. Also mention in which environment (OS, Node version, bundler if applicable) the code was executed.
+
+When asking for a feature, add some context about potential use cases. Our goal is to provide everything a developper could need to interact with Aleph Decentralized Network.
+
+
+## Opening a Pull Request
+
+Use the PR system to:
+
+- Submit a fix
+- Propose a new feature
+
+### How to contribute
+
+Like many project on Github we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr).
+
+1. Fork the repository to your own Github account
+2. Clone the project to your machine
+3. Create a branch locally with a succinct but descriptive name. If your PR is a bugfix, prefix it with `Fix/`. For example:
+    - You want to add the possibility to "create an account on `Chain X`", `Account/ChainX` 
+    - You want to fix a bug related to post messages not being publish `Fix/PostMessagePublish`
+4. Commit changes to the branch
+5. Push changes to your fork
+6. Open a PR in our repository. If an issue was opened related to your PR, link it in the description.
+
+### Some points to consider when opening a PR
+
+- One pull request per feature.
+- Keep your commit history clean, we do not abide by any specific rule but [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) are appreciated. We may ask you to rebase your branch in order to better track your changes. In the end your commits will be squashed into a single one into the main branch, so naming matters.
+- Your PR should be side-effect free (for instance if you are working on features for `Chain X` this should not introduce behavioral change to `Chain Y`)
+- Wether you are working on a new feature or a bugfix, please write some tests to validate that your changes are working.
+- Make sure that your code contains necessary doc comments (for auto documentation), do not leave debugging statements (such as `console.log` or debugger breakpoints) open, and avoid unnecessary comments.
+- Before submitting your PR, make sure your code is properly linted and that the test suite runs for every targetted environment.
+
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+You also agree to our [Code of Conduct](./CODE_OF_CONDUCT.md).

README.md

@@ -1,46 +1,31 @@
-# Getting Started with Create React App
+# Front Node Metrics Page
+This is a webpage that allows users to fetch last 2 weeks of metrics of all the nodes (CCN and CRN) in Aleph.im network
+![node-metrics-shots](https://github.com/aleph-im/front-node-metrics-page/assets/47140788/4934018f-da1a-4f7c-afa6-12bebe69a315)
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Getting Started
+1. Make sure you have [node and npm](https://nodejs.org/en/download/current) in your machine
+1. Clone this repository
+1. Install dependencies
+   ```sh
+   npm i
+   ```
+1. Start server locally
+   ```sh
+   npm start
+   ```
 
-## Available Scripts
+## Deployment
+Deploys are automated with GitHub Actions to happen for every push in the [`main`](https://github.com/aleph-im/front-node-metrics-page/tree/main) branch
 
-In the project directory, you can run:
+## Built With
 
-### `npm start`
+* [React](https://reactjs.org/) - The web framework used
+* [Plotly.js](https://plotly.com/javascript/) - Used to generate visual analytics
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Contributing
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
-### `npm test`
+## License
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details