clockwork-event-sourcing

[![Contributors][contributors-shield]][contributors-url]
[![License: MIT][license-shield]][license-url]

Clockwork Event Source Framework

Explore the docs »




Report Bug
·
Request Feature

Clockwork is a minimalist event sourcing framework that simplifies management of event queues and listeners.

##### Built With

- AWS S3
- Redis
- NodeJS
- TypeScript

Getting Started

To install Clockwork, follow these simple example steps.

``sh
$ cd your_project
$ yarn install --save clockwork-event-sourcing
$ yarn build
`

$3

`sh
> yarn build
`
This will create .js files for all .ts files found within the project folder. All new files will be created `./built`

$3

`sh
docker-compose build clockwork && docker-compose run --rm clockwork
`
Flushes Redis and runs built/example/test.js

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the LGPL 3.0 License. See LICENSE` for more information.

Acknowledgements

- GitHub Emoji Cheat Sheet
- Img Shields
- Photo by Miguel Á. Padriñán from Pexels

[contributors-shield]: https://img.shields.io/badge/CONTRIBUTORS-3-blueviolet?style=for-the-badge

[contributors-url]: https://github.com/canadiannomad/clockwork-event-sourcing/blob/master/AUTHORS.md

[license-shield]: https://img.shields.io/badge/license-MIT-green?style=for-the-badge

[license-url]: https://github.com/canadiannomad/clockwork-event-sourcing/blob/master/LICENSE