https://github.com/arizona-framework/arizona_example
Showcase for Arizona Framework
https://github.com/arizona-framework/arizona_example
arizona erlang otp rebar3 showcase
Last synced: 9 months ago
JSON representation
Showcase for Arizona Framework
- Host: GitHub
- URL: https://github.com/arizona-framework/arizona_example
- Owner: arizona-framework
- License: apache-2.0
- Created: 2024-06-26T21:32:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-28T04:20:21.000Z (9 months ago)
- Last Synced: 2025-09-28T05:41:30.950Z (9 months ago)
- Topics: arizona, erlang, otp, rebar3, showcase
- Language: Erlang
- Homepage:
- Size: 419 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# `arizona_example` [![CI][ci-img]][ci] [![Lint][lint-img]][lint]
[ci]: https://github.com/arizona-framework/arizona_example/actions/workflows/ci.yml
[ci-img]: https://github.com/arizona-framework/arizona_example/actions/workflows/ci.yml/badge.svg
[lint]: https://github.com/arizona-framework/arizona_example/actions/workflows/lint.yml
[lint-img]: https://github.com/arizona-framework/arizona_example/actions/workflows/lint.yml/badge.svg
This is an example project (`rebar3`-based) for showcasing [Arizona](https://github.com/arizona-framework/arizona)'s
capabilities, always aiming at the tip of its `main` branch (which is why there's no CHANGELOG).
To run it, boot the Erlang/`rebar3` shell: e.g. `rebar3 shell`.
If no errors were shown, the application should now be served at `localhost:8080`.
[arizona_example_showcase.webm](https://github.com/user-attachments/assets/e7cfd693-55b8-4752-b844-3b9175c9d54a)
## The project
### Changelog
There is no usable changelog. This example is always using Arizona's latest code.
### Code of Conduct
This project's code of conduct is made explicit in [CODE_OF_CONDUCT.md](https://github.com/arizona-framework/arizona_example/blob/main/CODE_OF_CONDUCT.md).
### Contributing
First of all, thank you for contributing with your time and energy.
If you want to request a new feature make sure to [open an issue](https://github.com/arizona-framework/arizona_example/issues)
so we can discuss it first.
Bug reports and questions are also welcome, but do check you're using the latest version of the
plugin - if you found a bug - and/or search the issue database - if you have a question, since it
might have already been answered before.
Contributions will be subject to the project's license.
For more information check out [CONTRIBUTING.md](https://github.com/arizona-framework/arizona_example/blob/main/CONTRIBUTING.md).
### License
License information can be found inside [LICENSE.md](https://github.com/arizona-framework/arizona_example/blob/main/LICENSE.md).
### Security
This project's security policy is made explicit in [SECURITY.md](https://github.com/arizona-framework/arizona_example/blob/main/SECURITY.md).