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

https://github.com/moov-io/fips-state-codes


https://github.com/moov-io/fips-state-codes

fips hacktoberfest

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README

          

[![Moov Banner Logo](https://user-images.githubusercontent.com/20115216/104214617-885b3c80-53ec-11eb-8ce0-9fc745fb5bfc.png)](https://github.com/moov-io)

[![GoDoc](https://godoc.org/github.com/moov-io/fips-state-codes?status.svg)](https://godoc.org/github.com/moov-io/fips-state-codes)
[![Build Status](https://github.com/moov-io/fips-state-codes/workflows/Go/badge.svg)](https://github.com/moov-io/fips-state-codes/actions)
[![Coverage Status](https://codecov.io/gh/moov-io/fips-state-codes/branch/master/graph/badge.svg)](https://codecov.io/gh/moov-io/fips-state-codes)
[![Go Report Card](https://goreportcard.com/badge/github.com/moov-io/fips-state-codes)](https://goreportcard.com/report/github.com/moov-io/fips-state-codes)
[![Repo Size](https://img.shields.io/github/languages/code-size/moov-io/fips-state-codes?label=project%20size)](https://github.com/moov-io/fips-state-codes)
[![Apache 2 License](https://img.shields.io/badge/license-Apache2-blue.svg)](https://raw.githubusercontent.com/moov-io/fips-state-codes/master/LICENSE)
[![Slack Channel](https://slack.moov.io/badge.svg?bg=e01563&fgColor=fffff)](https://slack.moov.io/)
[![GitHub Stars](https://img.shields.io/github/stars/moov-io/fips-state-codes)](https://github.com/moov-io/fips-state-codes)
[![Twitter](https://img.shields.io/twitter/follow/moov?style=social)](https://twitter.com/moov?lang=en)

# moov-io/fips-state-codes
Moov's mission is to give developers an easy way to create and integrate bank processing into their own software products. Our open source projects are each focused on solving a single responsibility in financial services and designed around performance, scalability, and ease of use.

fips-state-codes provides a mapping function to translate standard US based 2-alphanumeric state codes into FIPS 2-digit state codes.

## Project Status

fips-state-codes is included in multiple open-source projects Moov offers and is used in production environments. Please star the project if you are interested in its progress. If you find any bugs or desire additional encryption/encoding algorithms we would appreciate an issue or pull request. Thanks!

## Usage

Call the FIPSCodeFromStateCode function to translate a state code to a FIPS state code.

**Translate**
```go
// fipsStateCode contains value "17" in below example
fipsStateCode, err := fips_state_codes.FIPSCodeFromStateCode("IL")
if err != nil {
// do something
}
```

## Getting help

channel | info
------- | -------
Twitter [@moov](https://twitter.com/moov) | You can follow Moov.io's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories.
[GitHub Issue](https://github.com/moov-io/fips-state-codes/issues/new) | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error.
[moov-io slack](https://slack.moov.io/) | Join our slack channel to have an interactive discussion about the development of the project.

## Supported and tested platforms

- 64-bit Linux (Ubuntu, Debian), macOS, and Windows

## Contributing

Yes please! Please review our [Contributing guide](CONTRIBUTING.md) and [Code of Conduct](https://github.com/moov-io/ach/blob/master/CODE_OF_CONDUCT.md) to get started! Checkout our [issues for first time contributors](https://github.com/moov-io/watchman/contribute) for something to help out with.

This project uses [Go Modules](https://go.dev/blog/using-go-modules) and Go v1.18 or newer. See [Golang's install instructions](https://golang.org/doc/install) for help setting up Go. You can download the source code and we offer [tagged and released versions](https://github.com/moov-io/ach/releases/latest) as well. We highly recommend you use a tagged release for production.

## License

Apache License 2.0 - See [LICENSE](LICENSE) for details.