https://github.com/strangetom/shopping-list

Simple, offline capable shopping list web app.
https://github.com/strangetom/shopping-list

Last synced: about 1 month ago
JSON representation

Simple, offline capable shopping list web app.

• Host: GitHub
• URL: https://github.com/strangetom/shopping-list
• Owner: strangetom
• License: mit
• Created: 2023-01-02T15:37:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-14T19:41:02.000Z (3 months ago)
• Last Synced: 2024-08-14T21:51:28.911Z (3 months ago)
• Language: JavaScript
• Size: 407 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shopping List App

This is a fairly basic shopping list web app. The motivation behind creating this was to replace an (native) android app that I had been using for several years, but discovered it had been removed from the play store when I got a new phone.

It allows items to be added to the list, along with an optional quantity, unit and note. Items can be categorised into one of the predefined categories. The list is organised by category.

Once initially loaded, the web app works completely offline and is installable as a progressive web app.

When adding items to the list, suggestions will be presented based on a catalogue of items and predefined bundles of items. Whenever an item is marked as done in the list, the catalogue is updated to add that item (if it didn't previously exist) and update the last modified time.

Items marked as done are removed from the list when the app refreshed.

Since the catalogue is only updated locally, the download button can be used to download the catalogue in json format. This could be uploaded to the server meaning that new devices will get the updated catalogue.

Currently bundles are predefined in the ```bundles.json``` file. Future work may allow bundles to be created on device, but I've found that I rarely modified the bundles.

## Screenshots

Shopping list:

![shopping_list](./.screenshots/shopping_list.png)

Add item:

![new_item](./.screenshots/new_item.png)

Edit item:

![edit_item](./.screenshots/edit_item.png)

## Deployment

This web app is deployed statically.

Clone this repository to a location on the server and point a server to it.

An example nginx configuration file follows which will serve the web app at ```shopping.my-domain.xxx```:

```

server {

	server_name shopping.my-domain.xxx;

	root /path/to/shopping-list;

	index index.html

	try_files $uri.html $uri $uri/ =404;

	

	listen 80;

	listen 443 ssl http2;

	ssl_certificate /etc/letsencrypt/live/my-domain.xxx/fullchain.pem;

	ssl_certificate_key /etc/letsencrypt/live/my-domain.xxx/privkey.pem;

	include /etc/letsencrypt/options-ssl-nginx.conf;

	if ($scheme != "https") {

		return 301 https://$host$request_uri;

	}

}

```

Replace the domain and path to the repository with the appropriate values for your deployment.

Note that an SSL certificate is required for some PWA functionality such as installing the app.