<div align="center">
<h1>GeekORM</h1>
[][github]
[][crates-io]
[][crates-io]
[][github]
[][github-issues]
[][license]
<img src="./assets/geekorm.png" width="450" title="GeekORM Logo">
</div>
## Overview
[GeekORM][docs-orm] is a simple [Object Relation Mapper][docs-orm] for empowering your [Rust][rust-lang] development.
## ✨ Features
- Focus on simplicity
- Rely on Derive Macros to generate code for your structs
- Using `GeekTable`
- Dynamically build queries
- `Select`, `Create`, `Update`, and `Insert` queries
- Generate helper functions
- Select `select_by_primary_key()` & `select_by_{field}()`
- New instance `new`
- Support for Backends
- [`libsql`][lib-libsql] ([Turso][web-turso])
- [Documentation][docs]
## 📦 Usage
You can install the library from [crates.io][crates]:
```bash
cargo add geekorm
```
### Manual - GitHub
```bash
cargo install --git https://github.com/42ByteLabs/geekorm
```
## 🧑🤝🧑 Maintainers / Contributors
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://geekmasher.dev"><img src="https://avatars.githubusercontent.com/u/2772944?v=4?s=100" width="100px;" alt="Mathew Payne"/><br /><sub><b>Mathew Payne</b></sub></a><br /><a href="#code-GeekMasher" title="Code">💻</a> <a href="#review-GeekMasher" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/MsGeekMasher"><img src="https://avatars.githubusercontent.com/u/93775622?v=4?s=100" width="100px;" alt="Cale"/><br /><sub><b>Cale</b></sub></a><br /><a href="#design-MsGeekMasher" title="Design">🎨</a></td>
</tr>
</tbody>
</table>
## 🦸 Support
Please create [GitHub Issues][github-issues] if there are bugs or feature requests.
This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.
## 📓 License
This project is licensed under the terms of the MIT open source license.
Please refer to [MIT][license] for the full terms.
[license]: ./LICENSE
[crates-io]: https://crates.io/crates/geekorm
[docs]: https://docs.rs/geekorm/latest/geekorm
[rust-lang]: https://www.rust-lang.org/
[semver]: https://semver.org/
[github]: https://github.com/42ByteLabs/geekorm
[github-issues]: https://github.com/42ByteLabs/geekorm/issues
[crates]: https://crates.io
[docs-orm]: https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping
[lib-libsql]: https://github.com/tursodatabase/libsql
[web-turso]: https://turso.tech/