ajb3932/simple-wishlist repository overview

⁠📝 Simple Wishlist

Simple Wishlist is a Node.js application that allows users to conveniently organize their desired items in one place.

It features a secure admin panel for adding and deleting items, while family and friends can mark items as 'Purchased' to prevent duplicate gifts.

💁 Please be kind, this is my first Node.Js app.

⁠📷 Screenshot

⁠🐳 Docker

Docker Compose:

version: '3'
services:
  wishlist:
    image: ajb3932/simple-wishlist:latest
    container_name: wishlist
    hostname: wishlist
    ports:
      - 8092:8092
    environment:
      - DBHOST=mongodb:27017
      - CURRENCY=USD
      - LIST_NAME=My Wishlist
      - LIST_TYPE=bday
    depends_on:
      - mongodb

  mongodb:
    image: mongo:latest
    container_name: wishlist-db
    hostname: mongodb
    volumes:
      - mongodb_data:/data/db

volumes:
  mongodb_data:

Docker CLI:

⚠️ Must have a MongoDB to connect too.

docker run -d -p 8092:8092 -e DBHOST=10.0.0.10:27017 ajb3932/simple-wishlist

⁠🌍 Environment Variables

The following Environment Variables are available:

⁠🚀 First Run

When the app first runs it will take you to /setup where you will be asked to set up an admin login user.

⁠💻 Usage

/ The public wishlist page is the root of the web app. If you click purchased it will move the item to the 'Purchased' table

/admin The admin panel for the app. Here you can add and delete items on the wishlist.

Available fields to add an item:

/setup Only used on the first run and will not be available once an admin user has been set up.

⁠🙋 I want to run this myself

🐳 Docker

git clone https://github.com/ajb3932/simple-wishlist.git
cd simple-wishlist
docker build -t my-wishlist .
docker run -d -p 8092:8092 -e DBHOST=10.0.0.10:27017 my-wishlist

💾 Node.js

git clone https://github.com/ajb3932/simple-wishlist.git
cd simple-wishlist
npm install --production
node server.js