https://github.com/keep-starknet-strange/heimdall
Heimdall is the guardian of our best practices
https://github.com/keep-starknet-strange/heimdall
Last synced: 6 months ago
JSON representation
Heimdall is the guardian of our best practices
- Host: GitHub
- URL: https://github.com/keep-starknet-strange/heimdall
- Owner: keep-starknet-strange
- License: mit
- Created: 2022-11-22T17:44:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-16T00:28:07.000Z (over 2 years ago)
- Last Synced: 2024-10-12T23:50:51.951Z (7 months ago)
- Language: Rust
- Size: 924 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
[](LICENSE)
[](https://github.com/starknet-exploration/heimdall/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
Table of Contents
- [About](#about)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [GitHub analytics](#github-analytics)
- [Usage](#usage)
- [CLI](#cli)
- [Infra](#infra)
- [Roadmap](#roadmap)
- [Support](#support)
- [Project assistance](#project-assistance)
- [Contributing](#contributing)
- [Authors \& contributors](#authors--contributors)
- [Security](#security)
- [License](#license)
- [Acknowledgements](#acknowledgements)
---
## About
> **[?]**
> Provide general information about your project here.
> What problem does it (intend to) solve?
> What is the purpose of your project?
> Why did you undertake it?
> You don't have to answer all the questions -- just the ones relevant to your project.
Screenshots
> **[?]**
> Please provide your screenshots here.
| Home Page | Login Page |
| :-------------------------------------------------------------------: | :--------------------------------------------------------------------: |
| 
| |
### Built With
- [Rust](https://www.rust-lang.org/)
> **[?]**
> Please provide the technologies that are used in the project.
## Getting Started
### Prerequisites
- [Rust](https://www.rust-lang.org/tools/install)
> **[?]**
> What are the project requirements/dependencies?
### Installation
#### GitHub analytics
```sh
curl -sL https://raw.githubusercontent.com/keep-starknet-strange/heimdall/main/heimdall-rs/installers/githup | sh
```
## Usage
### CLI
```sh
cargo run -- --dir-path ./ comments check-comments
```
```sh
github-analytics 7 --print
```
### Infra
See infra readme [here](infra/README.md)
## Roadmap
See the [open issues](https://github.com/starknet-exploration/heimdall/issues) for a list of proposed features (and known issues).
- [Top Feature Requests](https://github.com/starknet-exploration/heimdall/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/starknet-exploration/heimdall/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Newest Bugs](https://github.com/starknet-exploration/heimdall/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
## Support
> **[?]**
> Provide additional ways to contact the project maintainer/maintainers.
Reach out to the maintainer at one of the following places:
- [GitHub Discussions](https://github.com/starknet-exploration/heimdall/discussions)
- Contact options listed on [this GitHub profile](https://github.com/starknet-exploration)
## Project assistance
If you want to say **thank you** or/and support active development of Heimdall:
- Add a [GitHub Star](https://github.com/starknet-exploration/heimdall) to the project.
- Tweet about the Heimdall.
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.
Together, we can make Heimdall **better**!
## Contributing
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!
## Authors & contributors
The original setup of this repository is by [Lucas Levy <@LucasLvy>](https://github.com/starknet-exploration).
For a full list of all authors and contributors, see [the contributors page](https://github.com/starknet-exploration/heimdall/contributors).
## Security
Heimdall follows good practices of security, but 100% security cannot be assured.
Heimdall is provided **"as is"** without any **warranty**. Use at your own risk.
_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._
## License
This project is licensed under the **MIT license**.
See [LICENSE](LICENSE) for more information.
## Acknowledgements
> **[?]**
> If your work was funded by any organization or institution, acknowledge their support here.
> In addition, if your work relies on other software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.