https://github.com/thesurlydev/langolier-api
API for Langolier, a personal digital garden and AI assistant.
https://github.com/thesurlydev/langolier-api
Last synced: about 1 year ago
JSON representation
API for Langolier, a personal digital garden and AI assistant.
- Host: GitHub
- URL: https://github.com/thesurlydev/langolier-api
- Owner: thesurlydev
- License: apache-2.0
- Created: 2023-06-24T15:57:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T18:09:26.000Z (almost 3 years ago)
- Last Synced: 2025-02-06T18:52:28.711Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 406 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# langolier-api
API for Langolier, a personal digital garden and AI assistant.
## Build
To build the project, run:
```shell
cargo build
```
## Container
To build the container, run:
```shell
docker build -t langolier-api .
```
## Run
To run the project, run:
```shell
docker compose up
```
## NATS
This project uses NATS for messaging. To run NATS locally, use the following command:
```shell
docker compose up -d nats
```
## Dependencies
To find outdated dependencies, run:
```shell
cargo outdated -R
```
## References
Here are reference docs for the crates used in this project:
- [axum docs](https://docs.rs/axum/latest/axum/) - web framework that focuses on ergonomics and modularity.
- [sqlx docs](https://docs.rs/sqlx/latest/sqlx/) - an async, pure Rust SQL crate featuring compile-time checked
queries without a DSL. Supports PostgreSQL, MySQL, and SQLite.
- [tracing docs](https://docs.rs/tracing/latest/tracing/) - a framework for instrumenting Rust programs to collect
structured, event-based diagnostic information.
- [serde docs](https://docs.rs/serde/latest/serde/) - framework for serializing and deserializing Rust data
structures efficiently and generically.