wishlist-app/README.md
2022-02-20 15:08:45 +01:00

1.6 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.

Demo

Open in CodeSandbox

Screenshots

Overview Image Detail Image

Features

  • Support of multiple wishlists
  • Items can be removed from the wishlist by anonymous users
  • Grab title, description and image-url from url via open graph meta tags
  • i18n support

Install

Docker Setup

The app can be easily installed via Docker compose. During installation, only a password (API key) and a path for the SQLite database must be specified.

version: '3.7'

services:
  wishlist:
    image: thisisbenny/wishlist-app:latest
    environment:
      - API_KEY=TOP_SECRET
    ports:
      - '5000:5000'
    volumes:
      - ./data:/app/data

Development Guide

npm install
npx prisma generate
npx prisma migrate deploy

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

Other stuff

"Buy Me A Coffee"