Meet Kijk: the open-source app that helps you understand and plan what you use – any resource you measure, such as electricity, water or fuel, with limits, and your money with budgets – privately for yourself and together in shared spaces with your household, flatmates or partner.
This Project is still under development
- Motivation
- Getting Started
- Developer Guide
- Deployment
- Built Using
- Contributing
- License
- Acknowledgments
At the core of Kijk is my motivation to explore new technologies while crafting an app that caters to every user, including myself. I embarked on this journey to create an app that makes it easy to understand and plan the resources and money a home uses, driven by my own need for such a tool. I invite you, as new users, to join this project. Let's collaborate on this open-source project, combining our skills to make Kijk an even more valuable tool for planning resources and budgets. Your participation and contributions will not only enhance the app's features but also ensure that it addresses a wider array of needs and preferences. Together, we can shape a tool that empowers us all to manage our homes efficiently and effortlessly.
Feel free to explore the codebase to get inspiration or help with this project 🫶
If you want to use the live production app go to this link and feel free to leave some feedback on our discussion board. And if you are a developer and want to contribute to this project please go here for more information.
Please refer to the contributing guide for how to install Kijk from sources.
Deployment is handled through the repository's GitHub Actions workflows.
- React - Frontend Library
- Vite+ - Frontend toolchain
- Tailwind - Styling
- dotnet - Server Framework
- PostgreSQL - Database
Kijk is licensed under AGPL-3.0-only with additional attribution and origin terms. Forks and commercial hosting are welcome: preserve the reference to Kijk and its original author, identify your changes, and follow the AGPL source-sharing requirements, including for modified versions used over a network. The full license and required attribution are in LICENSE.
- shadcn/ui
- The Documentation Compendium
- openAi for helping with writing texts 🤖