punix/noteshop-webapp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update README with features and usage instructions

Browse Source 
Adds a new Features section to highlight the applications
capabilities, including multi-user support, real-time updates,
and automatic language detection.

Expands the How to Use section with detailed instructions on
managing the shopping list, explaining how to add, mark, and
delete items, including the new deletion password requirement.
This commit is contained in:
Désiré Werner Menrath
2025-10-28 21:52:49 +01:00
parent 58836f7af6
commit eaf83385ca
1 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -8,6 +8,14 @@ This web service is the final development step for the accompanying **Android ap
**Current Status & Workaround:** While direct API integration in the app is still to be completed, the system is already fully functional using notifications. The text sent in the Gotify notification can be copied and pasted 1:1 into the Android app to instantly populate the shopping list.
## Features
* **Multi-user access:** Log in to manage the list. Includes an admin panel for user management.
* **Real-time updates:** The list updates in real-time for all connected users.
* **Automatic Language Detection:** The user interface automatically adapts to your browser's language. Currently, English and German are supported. Simply refresh the page after changing your browser or OS language settings.
* **Gotify Notifications:** Trigger notifications to your Gotify server.
* **Suggestion Box:** Get suggestions for items as you type.
## How to Use
Here is an example `docker-compose.yml` file:
@@ -45,8 +53,18 @@ After starting the container for the first time, a default administrator account
**Important:** For security reasons, please log in and change the default password immediately using the admin panel.
### Managing the Shopping List
* **Adding Items:**
* To add multiple items at once, type them into the input field separated by commas (e.g., `Milk, Bread, Eggs`). Press **Enter** or click the **Add** button.
* To add a single item exactly as typed (even if it contains commas), click the **+1** button.
* **Marking & Deleting Items:**
* Use the switch next to each item to mark it for deletion.
* To delete all marked items, click the trash can icon at the top right.
* **Important:** For security, you must first set a "Deletion Password" in the admin panel. This password is required to delete items from the list.
### Important Notes
* **User/Group:** Set `PUID` and `PGID` to your user's ID on the host system. You can find them by running the commands `id -u` and `id -g`.
* **Data Directory:** Before the first run, create a directory for the database: `mkdir data`.
* **Running:** Start the container with: `PUID=$(id -u) PGID=$(id -g) docker compose up -d`
* **Running:** Start the container with: `PUID=$(id -u) PGID=$(id -g) docker compose up -d`