Skip to content

stormsync/transformer

Repository files navigation

Docker

project-banner


Overview

The Stormsync data transformer is an open-source Go project designed for processing hail, wind, and tornado data that is coming from the collector microservice. After the data is processed it is published back to a Kafka topic.

Getting Started

System Requirements:

  • Go: version 1.22.x

Installation

From source

  1. Clone the repository:
$ git clone https://github.com/stormsync/transformer
  1. Change to the collector directory:
$ cd collector/cmd/transform
  1. Build the app:
$ go build -o app

Usage

From source

Run using the command below:

update with config file info

Tests

Run the test suite using the command below from the root directory of the repo:

$ go test ./...

Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your local account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client.
    git clone ../
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to local: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph


License

This project is protected under the GNU Affero General Public License v3.0


About

No description, website, or topics provided.

Resources

License

Stars

0 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors