summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2022-07-04 11:51:15 +0530
committerAndinus <andinus@nand.sh>2022-07-04 11:51:15 +0530
commitb93a3e28c3634bb80fa7814a37672f9153c9bb46 (patch)
treeca9d61713b36eab8dac46b171fc716cee236a225
parentb2f6a80a69eaa4d9bd4c421c04fe159f3f27ab17 (diff)
downloadcrater-b93a3e28c3634bb80fa7814a37672f9153c9bb46.tar.gz
Add design, Update history
-rw-r--r--README.org53
1 files changed, 53 insertions, 0 deletions
diff --git a/README.org b/README.org
index c8d523b..b8a99fa 100644
--- a/README.org
+++ b/README.org
@@ -9,6 +9,54 @@
 
 Crater is a media gallery.
 
+* Design
+
+- This is the roadmap for v0.2.0. It is a work in-progress.
+
+Crater is a web application to view media gallery. It allows to create
+/sharing albums/ to share gallery with others.
+
+On creating a /sharing album/ it will generate an access code, others can
+use the access code to view the specific album.
+
+** Authorization
+
+*** Admin
+
+The CLI will generate a random code for admin login.
+
+Admin will be able to view the entire media gallery. They will also be
+able to add pictures to a /sharing album/ and view the access code for it.
+
+*** Guests
+
+Guests will have to enter the access code. On authorization the page
+will be rendered with all the images that has been added to the /sharing
+album/.
+
+** View
+
+We could show the entire gallery in a single page. The images can be
+restricted to ~n~ (set by user) and user can load more.
+
+There could be filters (by name, date, etc.) and sorting.
+
+I'm thinking of a page like:
+#+begin_src
+2022
+
+June
+---- pictures ----
+May
+---- pictures ----
+
+
+2020
+
+December
+---- pictures ----
+#+end_src
+
 * History
 
 Initially I planned to make a simple gallery to share pictures with
@@ -23,6 +71,11 @@ I want to expand this to make a media gallery that I can use to view my
 pictures/videos. And I also want to be able to create album out of them
 and share it with my friends.
 
+I'm creating this because I don't have a way to viewing my media
+gallery. My primary computer runs OpenBSD. It initially was for me to
+share pictures with friends and web was a good platform for that. I
+think it's a good platform for this purpose as well.
+
 * License
 
 #+begin_src