62 lines
4.2 KiB
Markdown
62 lines
4.2 KiB
Markdown
## 🤖 Klectr: We Klecting Your Collections! ️
|
||
|
||
### A Short Introduction
|
||
|
||
Klectr is a software organization fueled by caffeine and a passion for building awesome applications! ☕ We specialize in creating user-friendly tools called "Klectr" apps that help you **Klect** (collect ) the things that matter to you.
|
||
|
||
Imagine a world where you can effortlessly organize your favorite radio stations with KlectrRadio, keep your thoughts and ideas neatly categorized with KlectrNotes, or track your fitness journey with KlectrWeight!
|
||
|
||
These are just a few examples - we're constantly brainstorming innovative ways to Klect all sorts of things!
|
||
|
||
### Contribution Guidelines
|
||
|
||
We believe in the power of collaboration! If you're a developer who shares our passion for building useful tools, we'd love for you to join the Klectr fam.
|
||
|
||
Each Klectr app has its own repository on GitHub. These repositories include detailed contribution guidelines to help you get started on creating awesome features or fixing any bugs you might encounter.
|
||
|
||
### Useful Resources
|
||
|
||
* **Klectr on GitHub:** [https://github.com/orgs/Klectr/repositories](https://github.com/orgs/Klectr/repositories) (Find all our Klectr apps here!)
|
||
* **Individual Project Repositories:** Contribution guidelines and specific details for each Klectr app can be found in their respective repositories on GitHub.
|
||
|
||
We're excited to see what you Klect with our apps! ✨
|
||
|
||
## 🧰 Tools We Use
|
||
[Typescript](https://www.typescriptlang.org/docs/)|
|
||
[Tauri](https://tauri.app/v1/guides/)|
|
||
[Rust](https://www.rust-lang.org/learn)|
|
||
[Bun](https://bun.sh/docs)|
|
||
[Kaioken](https://kaioken.dev/docs/introduction)
|
||
|
||
### Typescript
|
||
|
||
- Strongly Typed: Typescript adds static type checking to JavaScript, which helps catch errors early in the development process and improves code maintainability.
|
||
- Improved Developer Experience: Features like code completion and refactoring make development faster and more enjoyable.
|
||
- Large Community & Ecosystem: Typescript benefits from a large and active community, with a vast array of libraries and frameworks available.
|
||
|
||
### Tauri
|
||
|
||
- Native Desktop Apps with Web Technologies: Tauri allows us to build performant, cross-platform desktop applications using familiar web technologies like HTML, CSS, and Javascript.
|
||
- Reduced Development Time: By leveraging existing web skills, Tauri can streamline development and reduce time to market.
|
||
- Flexibility: Tauri integrates well with various frontend frameworks like React or Vue.js, offering flexibility in building the UI.
|
||
|
||
### Rust
|
||
|
||
- Memory Safety & Performance: Rust enforces memory safety through its ownership system, preventing crashes caused by memory leaks and dangling pointers. It also compiles to highly performant native code.
|
||
- Concurrency Features: Rust provides excellent support for concurrency with features like channels and mutexes, simplifying the development of concurrent applications.
|
||
- Growing Ecosystem: While still evolving, Rust boasts a rapidly growing community and rich ecosystem of libraries.
|
||
|
||
### Bun
|
||
|
||
- Speed & Efficiency: Bun is an incredibly fast JavaScript runtime designed for performance. It boasts faster startup times and lower memory usage compared to traditional Node.js.
|
||
- Zero-Configuration: Bun requires minimal configuration, streamlining the development process. It includes a built-in package manager and development server.
|
||
- Modern JavaScript Features: Bun natively supports modern JavaScript features like modules and top-level await, eliminating the need for transpilation.
|
||
|
||
### Kaioken
|
||
|
||
- A Lightweight JavaScript Rendering Library
|
||
- Similar to React: Kaioken offers a familiar development experience for those familiar with React, using JSX syntax and a component-based architecture.
|
||
- Focus on Simplicity and Performance: Unlike React, Kaioken prioritizes a smaller footprint over an exhaustive feature set. This makes it ideal for performance-critical applications or those targeting low-powered devices.
|
||
- Modern Feature Integration: Kaioken embraces modern features like the built-in Zustand-based Store API for state management.
|
||
- Open Source & Future-Oriented: Being open-source, Kaioken welcomes contributions and is constantly evolving, with a roadmap that includes server-side rendering capabilities.
|