horusec-devkit

module
v1.0.18 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2021 License: Apache-2.0

README

logo_header

Horusec Development Kit

This repository has all the reused Horusec codes in one place.

How does DevKit work?

DevKit is the repository where there are some abstractions Horusec's team use to simplify development and testing. For example:

  • If you want a code to help you make an HTTP request or if you need a database, you can find it here.

It is reusable codes from other projects, like CLI, Engine, Platform, and Operator. See below DevKit's structure:

Entities

We keep all entities shared by multiple microservices here. For example, analysis and vulnerability structs, which are used from the CLI to the web services.

Enums

Enums refers to all the constants shared between the services. For example, the vulnerability severity constant.

Service

You will find here some abstractions from the libraries we use. The difference between service and utils is that here they need an instance or a connection to some requirement. For example, the abstraction of the RabbitMQ library for Go, which simplifies testing and development.

Utils

The utils refer to an abstraction in which instantiation or connection is not necessary. Just import and use it, simply and quickly. For example, the abstraction from the Logrus library was adapted to make it more comfortable to use.

Documentation

For more information about Horusec, please check out the documentation.

Contributing

If you want to contribute to this repository, access our Contributing Guide. And if you want to know more about Horusec, check out some of our other projects:

Community

Feel free to reach out to us at:

This project exists thanks to all the contributors. You rock! ❤️🚀

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL