From 768c8c60b8d698bfda154a67d46b13b5cbfa9197 Mon Sep 17 00:00:00 2001 From: Jade Date: Thu, 4 May 2023 10:47:08 +0200 Subject: [PATCH 1/2] update TODOs --- README.md | 46 ++++++++++++++++++++++++++++------------------ 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 506cbb6..1ebd02f 100644 --- a/README.md +++ b/README.md @@ -86,39 +86,49 @@ This is only a rough time guide for what to get done by which version, nothing f ### v2.1 +*Focus: Modularity, Programmability, APIs* + - [ ] Installation guides - [x] nix flake -- [ ] Copying embed urls more easily (some button for that) - - [ ] "raw" if it isn't an image, if it is "embed" -- [ ] Api for requesting customized api info -- [ ] Config file support -- [ ] Markdown pastas +- [ ] Api for requesting customized api info (.well-known endpoint) +- [ ] Non-web client library +- [ ] CLI client +- [ ] better remove api and granularity ### v2.2 -- [ ] Proper docs -- [ ] Improved rustdoc -- [ ] Non-web client library -- [ ] CLI client -- [ ] Easier customization of instance names and logos +*Focus: Configurability* + +- [ ] Config file support - [ ] Easier basic themeing - [ ] Colors - [ ] Corner rounding +- [ ] Proper docs +- [ ] Improved rustdoc +- [ ] Easier customization of instance names and logos ### v2.3 +*Focus: Better pastas* + - [ ] Encrypted pastas +- [ ] Copying embed urls more easily (some button for that) + - [ ] "raw" if it isn't an image, if it is "embed" +- [ ] Markdown pastas ### v3.0 -- [ ] Deprecate JSON db, replace with SQLite -- [ ] Rework internal data structures - - [ ] Map custom keys to ids - - [ ] Make hash ids, names and custom keys usable at once -- [ ] Users - - [ ] Reporting pastas - - [ ] Admin panel -- [ ] Improve remove api +- [ ] entirely new frontend +- [ ] Authentication + - [ ] basic logins + - [ ] oidc + - [ ] Moderation + - [ ] Permission system + - [ ] admin panel +- [ ] Deprecate JSON db, replace with SQLite and postgres support + - [ ] Rework internal data structures + - [ ] Map custom keys to ids + - [ ] Make hash ids, names and custom keys usable at once - [ ] Status/health/info improvements - [ ] Storage thats left - [ ] Db status From 68996acd5437b4d84c9092bd106f4c60c2ac7e34 Mon Sep 17 00:00:00 2001 From: Jade Date: Thu, 4 May 2023 11:55:43 +0200 Subject: [PATCH 2/2] update TODOs (again) --- README.md | 85 ------------------------------------------------------- TODO.md | 54 +++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 85 deletions(-) create mode 100644 TODO.md diff --git a/README.md b/README.md index 1ebd02f..b5f6a08 100644 --- a/README.md +++ b/README.md @@ -67,91 +67,6 @@ Add the repository to your inputs. } ``` -## Roadmap - -This is only a rough time guide for what to get done by which version, nothing fixed. - -### v2.0 - -- [x] Removed light mode -- [x] Rebrand - - [x] New name and logo - - [x] New README - - [x] New theme -- [x] Distribution on crates.io -- [x] Distribution on Docker hub -- [x] Image embedding in pasta page -- [x] Custom names file -- [x] Click logo/name to get to root - -### v2.1 - -*Focus: Modularity, Programmability, APIs* - -- [ ] Installation guides - - [x] nix flake -- [ ] Api for requesting customized api info (.well-known endpoint) -- [ ] Non-web client library -- [ ] CLI client -- [ ] better remove api and granularity - -### v2.2 - -*Focus: Configurability* - -- [ ] Config file support -- [ ] Easier basic themeing - - [ ] Colors - - [ ] Corner rounding -- [ ] Proper docs -- [ ] Improved rustdoc -- [ ] Easier customization of instance names and logos - -### v2.3 - -*Focus: Better pastas* - -- [ ] Encrypted pastas -- [ ] Copying embed urls more easily (some button for that) - - [ ] "raw" if it isn't an image, if it is "embed" -- [ ] Markdown pastas - -### v3.0 - -- [ ] entirely new frontend -- [ ] Authentication - - [ ] basic logins - - [ ] oidc - - [ ] Moderation - - [ ] Permission system - - [ ] admin panel -- [ ] Deprecate JSON db, replace with SQLite and postgres support - - [ ] Rework internal data structures - - [ ] Map custom keys to ids - - [ ] Make hash ids, names and custom keys usable at once -- [ ] Status/health/info improvements - - [ ] Storage thats left - - [ ] Db status - - [ ] Pastas on the instance - - [ ] Users - - [ ] Errors - -### future - -- [ ] Federation - - [ ] Requesting pastas from other instances - - [ ] When cli is complete, set default instance to route requests over - - [ ] Fine grained permissions -- [ ] Postgresql db support -- [ ] Pasta comments? - -### not related to features, therefor not versioned - -- [ ] Official central instance -- [ ] Donation setup? -- [ ] Distribution on nixpkgs -- [ ] Website - ## Contact This fork of MicroBin was created by [Schrottkatze](https://schrottkatze.de). diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..559543e --- /dev/null +++ b/TODO.md @@ -0,0 +1,54 @@ +# TODO lists + +these are just rough guides tho + +## v2.1 + +- [ ] customizable endpoints + - [ ] create + - [ ] edit + - [ ] info + - [ ] get pastas + - [ ] remove +- [ ] improve remove endpoint + - [ ] disable it +- [ ] client library + - [ ] request .well-known data + - [ ] support most endpoints +- [ ] karton cli + +## v3.0 + +- [ ] internal rewrite & docs +- [ ] design new frontend +- [ ] switch to yew + - [ ] using client lib +- [ ] theme and general config files + - [ ] unified theme format + - [ ] no env configs anymore if possible +- [ ] proper dbs + - [ ] sqlite + - [ ] postgres +- [ ] apis/endpoints + - [ ] IDs, name IDs AND user/pastaname + - [ ] root (and admin) user for root level pastas +- [ ] status/instance health admin dashboard and ap + - [ ] storage + - [ ] db status + - [ ] how up to date + - [ ] stats (users etc) + - [ ] errors + - [ ] loading speeds, performance monitor? + - [ ] memory use +- [ ] auth + - [ ] general auth + - [ ] oidc + - [ ] permssion system & api keys + - [ ] only allow some other users to open pasta + - [ ] access control and editing + - [ ] password protected pastas too +- [ ] features for pastas + - [ ] pw protection + - [ ] better editor + - [ ] markdown pastas + - [ ] optional, opt-in commenting