wishlist-app/README.md
Benny Samir Hierl b42767b003 fix readme
Signed-off-by: Benny Samir Hierl <bennysamir@posteo.de>
2022-01-29 18:05:55 +01:00

1 KiB

wishlist

The wishlist app is a simple webapp for publishing wishlists. It allows to share wishlists for different people or occasions with friends and family. If something was bought from the wishlist, it can be removed from the list to prevent duplicate purchases.

The app can be easily self-hosted via Docker (see docker-compose example below).

Feature Roadmap

  • i18n support
  • Administrate wishlists
  • Grab title, description and image-url from url via open graph meta tags
  • Login
  • Image upload

Docker Setup

version: '3.7'

services:
  wishlist:
    image: thisisbenny/wishlist-webapp:latest
    ports:
      - '5000:5000'
    volumes:
      - ./data:/app/data

Development Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint