wishlist-app/README.md
2022-02-07 08:56:34 +01:00

1.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 from the wishlist was bought, 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).

Features

  • Support of multiple wishlists
  • Items can be removed from the wishlist by users
  • i18n support

Feature Roadmap

  • 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-app: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

npm run test:unit

Lint

npm run lint

Typecheck

npm run typecheck