https://github.com/qhwa/bonfire
A delightful website for tracking reading state of books.
https://github.com/qhwa/bonfire
Last synced: 6 months ago
JSON representation
A delightful website for tracking reading state of books.
- Host: GitHub
- URL: https://github.com/qhwa/bonfire
- Owner: qhwa
- Created: 2020-02-27T00:14:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T08:48:28.000Z (almost 3 years ago)
- Last Synced: 2024-02-13T20:23:51.222Z (almost 2 years ago)
- Language: Elixir
- Homepage: https://bonfire.ooo
- Size: 14.8 MB
- Stars: 67
- Watchers: 2
- Forks: 5
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-elixir-cqrs - Bonfire - A small project for exploring some interesting approaches to a delightful web application. (Example applications / 2021)
README
# Bonfire
A small project for exploring some interesting approaches to a delightful web application.
## Motivation
* to get inspirations on interesting books/papers from others
* to explore most recent technologies on building and deploying a web application
* try to use as little JavaScript as possible by leveraging [Phoenix LiveView]
Some of the frameworks/libraries used:
* [Phoenix] for web framework
* [Phoenix LiveView] for almost-no-javascript application
* [Commanded] for [Event Sourcing]
* [Pow] for authentification
* [Rio] for deployment
* [dockerize] for docker image building
* [AppSignal] for APM (Application Performance Monitoring) and exception watching. Grateful thanks to [AppSignal] for the sponsorship.
Libraries are picked for practicing reason, you can find more background information in the [design document](https://github.com/qhwa/bonfire/blob/master/design/design.md).
## Warning
This project is not ready for a serious production yet. It's still under active development. It needs more tests, a CI process, and contains bugs.
## Develop
[guides/develop](guides/develop.md)
## Roadmap
* 1.0: core features
* [x] reading state CURD
* [x] user authentication
* [x] checkins
* 2.0: social features
* [ ] following
* [ ] email notification
* 3.0: gaming
* [x] a game which will encourage users to do more reading
* [ ] a game helping to form a reading habit
[Phoenix]: http://www.phoenixframework.org/
[Phoenix LiveView]: https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html
[Commanded]: https://github.com/commanded/commanded
[Event Sourcing]: https://martinfowler.com/eaaDev/EventSourcing.html
[Rio]: https://rio.io
[Pow]: https://powauth.com/
[credo]: https://github.com/rrrene/credo/
[dialyxir]: https://github.com/jeremyjh/dialyxir
[dockerize]: https://github.com/qhwa/dockerize
[AppSignal]: https://appsignal.com/
## License
[MIT](https://ocw.mit.edu/index.htm)