An open API service indexing awesome lists of open source software.

https://github.com/arquivei/foundationkit


https://github.com/arquivei/foundationkit

go golang hacktoberfest

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

# Foundation Kit

[![PkgGoDev](https://pkg.go.dev/badge/github.com/arquivei/foundationkit)](https://pkg.go.dev/github.com/arquivei/foundationkit)
[![Go Report Card](https://goreportcard.com/badge/github.com/arquivei/foundationkit)](https://goreportcard.com/report/github.com/arquivei/foundationkit)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

This project contains very opinionated packages for common operations.

## Getting Started

These instructions will give you a copy of the project up and running on
your local machine for development and testing purposes. See deployment
for notes on deploying the project on a live system.

### Prerequisites

Requirements for the software and other tools to build, test and push:

- [go](https://go.dev/)
- [golangci-lint](https://golangci-lint.run/): for linting.

### Linting

Please run `golangci-lint run` before submitting code.

### Godoc

To read the godoc documentation run:

```sh
godoc -http=localhost:6060
```

and open `http://localhost:6060` on your browser.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
of conduct, and the process for submitting pull requests to us.

## Versioning

We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
available, see the [tags on this
repository](https://github.com/arquivei/foundationkit/tags).

## License

This project is licensed under the _BSD 3-Clause_ - see the [LICENSE.md](LICENSE.md) file for
details.