Intro
✖️ hex is an ecosystem delivering practices, philosophy and portability.
hex consists of a set of components that are designed to be used together. These sub-components enable developers to abstract their codes for better portability between platforms. Encourages ones to write codes once in functional approach, then run on mainstream environments such as cli, bot platforms, cloud-function runtimes and web apis.
⚙ Components
Component | Area | Description |
---|---|---|
Directives | Rules | |
Standards | Abstraction | |
FP | Functions Library | Tools for functional programming |
StdX | Functions Library | Encriched Standard Library |
Data | Objects Library | Data Objects and Patterns |
Environment | Objects Library | Environment adapters |
Formatters | Objects Library | Object serializers/deserializers |
CLI | Manager | CLI library |
DI | Manager | Dependency injection library |
Functions | Manager | Functions runtime |
I18N | Manager | Internationalization library |
Options | Manager | Configuration library |
See the respective component page to figure out its specific usage.
🚀 Jumpstart
Ensure that Deno 1.27 or higher is installed on your system first.
Alternative I:
Install hex cli globally first, then create a new project:
$ deno run -A https://hexfw.deno.dev
$ hex create my-project
Creating "hex framework web template 0.0.1" on my-project...
...
done.
Alternative II:
Without any preparation, invoke creating a new project remotely:
$ deno run -A https://hexfw.deno.dev create my-project
Creating "hex framework web template 0.0.1" on my-project...
...
done.
Alternative III:
Or run a hex routines directly from the resource:
$ deno run https://deno.land/x/hex/src/lib/functions/samples/basic.ts eser
{ payload: "hello eser" }
📖 FAQ
Want to report a bug or request a feature?
Please read through our CONTRIBUTING.md and report it using GitHub Issues!
Want to contribute?
It is publicly open for any contribution. Bugfixes, new features and extra components are welcome.
Check out issues with the good first issue
and help wanted
label if you are
not sure how to begin. We suggest also looking at the closed ones to get a sense
of the kinds of issues you can tackle.
Fork the repo, push your changes to your fork, and submit a pull request.
Requirements
- Deno 1.27 or higher (https://deno.land/)
License
Apache 2.0, for further details, please see LICENSE file.
To Support
Visit my GitHub Sponsors profile at github.com/sponsors/eserozvataf