https://github.com/fcevado/shapt
🏴☠️ An elixir feature toggle|flag|flipper library to make Blackbeard envy 🏴☠️
https://github.com/fcevado/shapt
elixir elixir-lang feature-flags feature-flipper feature-toggles
Last synced: 3 months ago
JSON representation
🏴☠️ An elixir feature toggle|flag|flipper library to make Blackbeard envy 🏴☠️
- Host: GitHub
- URL: https://github.com/fcevado/shapt
- Owner: fcevado
- License: other
- Created: 2019-07-13T03:27:45.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-02-20T19:09:58.000Z (over 3 years ago)
- Last Synced: 2024-09-16T18:23:11.272Z (9 months ago)
- Topics: elixir, elixir-lang, feature-flags, feature-flipper, feature-toggles
- Language: Elixir
- Homepage: https://hex.pm/packages/shapt
- Size: 52.7 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Shapt
A helpful and simple way to use feature toggles/flippers/flags on your Elixir code.
This library heavily uses macros to achieve it's goals. Please read our [usage guide](./USAGE.md).
This is library is currently a work in progress, it's api is not *strongly* defined, *expect changes*.
## [Name](./NAME.md)
Do what you want 'cause a pirate is free
You are a pirate!
Yar har, fiddle de dee
Being a pirate is alright to be
Do what you want 'cause a pirate is free
You are a pirate!
## Features
This are the list of main features(marked ones are already implemented):
* [x] Configurable adapters that are simple to implement.
* [x] `Shapt.Adapters.Env` and `Shapt.Adapters.DotEnv` built-in Adapters.
* [x] `shapt.expired` mix task that exposes toggles that had his deadline expired.
* [x] `shapt.template` mix task that generate template files for the configured adapter.
* [x] Plug that provides a `GET` endpoint to inspect current state of the toggles.
* [x] Plug that provides a `POST` endpoint that reload toggles value(reload feature must be provided by the Adapter).
* [ ] Consul Adapters
## [Usage Guide](./USAGE.md)
Read our usage guide to understand how to start using this library.
## Credits
This library is inspired by several ideas from [Renan Ranelli](https://github.com/rranelli).
## [Changelog](./CHANGELOG.md)
* current version v0.0.1
## [Code of Conduct](./CODE_OF_CONDUCT.md)
## License
Shapt is under Apache v2.0 license. Check the [LICENSE](./LICENSE.md) file for more details.