49 lines
1.9 KiB
Markdown
49 lines
1.9 KiB
Markdown
# appname here
|
|
================
|
|
|
|
Yet Another Not-Invented-Here-Proof Productivity Tool
|
|
|
|
## Table of Contents
|
|
-----------------
|
|
|
|
* [Getting Started](#getting-started)
|
|
* [Features](#features)
|
|
* [Configuration](#configuration)
|
|
* [Usage](#usage)
|
|
* [Caveats/Todos](#caveats)
|
|
|
|
## Getting Started
|
|
---------------
|
|
|
|
To get started with this project, you will need to have Rust installed on your system. You can download the latest version of Rust from the official [Rust installation page](https://www.rust-lang.org/tools/install) or use an automatic rust toolchain installer [rustup](https://rustup.rs).
|
|
|
|
Once you have Rust installed, you can clone this repository and build the project using the following commands:
|
|
|
|
```bash
|
|
git clone https://github.com/semubico/app.git
|
|
cd app
|
|
cargo build
|
|
```
|
|
|
|
## Configuration
|
|
-----
|
|
|
|
A limited set of configuration parameters is configurable via environment variables.
|
|
Convenience .env file containing all of them is provided in the root of the project.
|
|
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
cd app
|
|
cargo run
|
|
```
|
|
|
|
## Caveats/Todos
|
|
-----
|
|
|
|
* /links endpoint accepts several GET parameters, which yet have no corresponding form elements. those are ( offset, count, query )
|
|
* Loglevel might be increased to DEBUG or TRACE for better debugging, which in turn will cause significant slowdown in all database-related activities. Notably under /links endpoint. Consider lowering number of records per page with "?count=<amount>"
|
|
* Even though the .env has schema 'sqlite3://' present, it doesn't (yet) mean that it's interchangable with mysql or postgres. AsyncProviders need to be rewritten over generic sqlx connection pool in order to support that. Sqlite is the only supported backend for now. Alternative backends may be provided by implementing AsyncProviders for them with different <T> parameter. (So yes, plain files storage is also supported)
|
|
* Add handlebars helper to format datetime as smth readable
|
|
* Myriad of other todos in the source files (u can safely ignore those)
|