From 6caea2b785b72edc33954674b9c96b3e373441b4 Mon Sep 17 00:00:00 2001 From: piotrruss Date: Wed, 1 Jun 2022 18:07:44 +0100 Subject: update description --- README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 89 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e89f81e..b05d9d1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,91 @@ -# My Apps (WIP) +# My Apps + +Screenshot: + +![Game of life](screenshot.jpg) ## Productivity apps created with Next.js + +A desktop-like web application with growing set of small productivity apps. +It is hosted at: [apps.pruss.it](https://apps.pruss.it) + +## Registration + +To use My Apps user need to create an account by providing email and chosen password. +User can also choose at this point prefered language and set of colors (theme). +Language and theme are saved for specific user and can be altered later inside My Apps settings. + +## Verification + +After registration an email with verification code is sent to choosen email address. +User will be asked to retype this code in the My Apps before obtaining full functionality. + +## Layout + +After verification user can see top bar with his email (logged user) on the right. +The rest of the screen is occupied by the desktop with application icons. +In desktop each app is opening in a separate window, which can be moved, minimised or closed. +Open apps also show up in the top bar (active one showing in bold). + +## Account menu + +After clicking at the logged user email in the top bar account menu shows up. +It allows user to: +- change password +- modify settings +- log out + +## Apps + +To open app click 2x on the selected app's icon. + +### Calculator + +Calculator app that allows simple math operations. +In addition to displaying the result, it also gives the current history of the operation. + +### Notes + +Note taking application. First screen displays list of notes and allows user to sort notes by title, creation date and modification date. +Main app menu has following options: +- New note - allows user to input title and content of a new note +- Import - allows import of single/multiple .txt files into the notes list +- Export - allows user to export multiple notes in a .zip archive + +Cliking on one of the notes on the list moves user to note view. +In note view user have the folowing menu buttons available +- Back - returns to notes list +- Copy - copies note's content +- Edit - allows user to change note's title and content +- Export - allows user to download single note as a .txt file +- Remove - removes note + +Edit, download and remove options are also available directly from the notes list by hovering over choosen note (shortcut buttons will show up). + +If you like this note taking web application you might be also interested in the: +- mobile client ([see in repository](https://git.pruss.it/notes_mobile/about/)) +- CLI client ([see in repository](https://git.pruss.it/notes_cli/about/)) + +### Youtube search + +Application made to allow user to search Youtube website for the following categories: +- Videos +- Live +- Playlists + +To use it just type what you are searching for and click Search button (or press enter). +You will see a list of results with thumbnail, title, channel name, duration, number of views and posting time for each result. +On the right side of the app menu you can also choose if you want to enqueue clicked result to player or override current playlist. +If you choose Playlists category all items from playlist will be added to Player. + +### Player + +Plays content, currently only from Youtube search but I plan to add other apps. +In the app menu user has following options (from the left): +- toggle playlist +- toggle video/audio stream (audio stream saves bandwidth) +- go to previous playlist item +- stop playing +- start playing +- go to next playlist item +- show video description -- cgit v1.2.3