schklom / poenskelisten

A self-hosted application for sharing wishlists and collaborating on gifts and presents.

Pønskelisten

Introduction - What is this? 🎁

A website-based application for sharing and collaborating on wishlists and presents. The main goal is to allow the sharing of wishlists and the claiming gift ideas without the recipient knowing what they are receiving.

Notable features:

• Group people using, well, groups
• Create wishlists, with wishes
• Have multiple wishlists shared with multiple groups. This allows you to have synchronized wishlists for multiple people, without them having to see each other's wishlists
• Wish claiming. Someone can claim a gift on a wishlist they are allowed to see. Anyone else who can see that wishlist then knows that gift idea is taken. The owner can't see this of course

Known issues:

• There currently is no admin interface to add invitation codes
• No email account confirmation through SMTP
• Can't leave groups someone else added you too
• Can't add additional wishlist owners
• Can't edit group/wishlist/wish details
• Can't change account information
• UI Can be a bit cluttered on smaller screens such as phones
• Wishlist expiration is not utilized yet

Installation - A bit cumbersome 😰

I recommend using Docker honestly.

1. You need a database

A MySQL database specifically. In the future, this process will be streamlined and the different databases supported by the DB module will be added. But for now, setup a MySQL database that Pønskelisten can reach and log into.

If you are hosting this manually you could download XAMPP and just click "start" on the DB feature. If you are using Docker, use the MySQL Docker image. There is a Docker compose example further down.

Create a table for Pønskelisten (Docker image does this automatically), and use that name in the next step.

2. Configure the /files/config.json file

Edit the config file so it can reach the MySQL database. There is no admin interface currently so this must be done manually in the file. The timezone is also necessary, but the private key should populate automatically. The SMTP settings do nothing currently.

3. Start Pønskelisten

Either compile your chosen branch/tag with Go:

$ go build
$ ./poenskelisten

... or download a pre-compiled release and start the application.

It should say whether or not it started and managed to connect to the database. Pønskelisten is now up and running.

4. Be able to alter the DB

Once again, there is no admin interface. To create invitation codes (needed to sign up currently), you need to add them to the database table. Cumbersome, I know.

I recommend installing PHPMyAdmin (DB interface) either as a Docker image or locally (it comes pre-packaged in XAMPP).

After accessing the DB through an interface, or by just running SQL commands, add an invitation code to the table invitations. You should now be able to sign up using the code at Pønskelisten frontend.

By default you can find the frontend at localhost:8080.

You need an invitation code for every user.

MySQL example command for adding an invitation code called "RANDOMCODE":

INSERT INTO `invites` (`id`, `created_at`, `updated_at`, `deleted_at`, `invite_code`, `invite_used`, `invite_recipient`, `invite_enabled`) VALUES (NULL, CURRENT_TIME(), CURRENT_TIME(), NULL, 'RANDOMCODE', '0', NULL, '1'); 

Be prepared to access the DB every time a user manages to screw up their e-mail while signing up or someone needs an invitation code.

Docker-Compose example

It has Pønskelisten, MySQL DB and PHPMyAdmin.

version: '3.3'
services:
  db:
    image: mysql:5.7
    container_name: poenskelisten-db
    restart: unless-stopped
    environment:
      # The table name you chose
      MYSQL_DATABASE: 'db'
      # User, so you don't have to use root 
      MYSQL_USER: 'myuser'
      # Please switch this password
      MYSQL_PASSWORD: 'mystrongpassword' 
      # Password for root access, change this too
      MYSQL_ROOT_PASSWORD: 'root' 
    networks:
      - db
    expose:
      - '3306'
    # Where our data will be persisted
    volumes:
      - ./db/:/var/lib/mysql/ # Location of DB data
  poenskelisten:
    container_name: poenskelisten-app
    image: aunefyren/poenskelisten:latest
    restart: unless-stopped
    networks:
      - db
    depends_on:
      - db
    volumes:
      - ./data/:/app/files/
    ports:
      - '8080:8080'
  phpmyadmin:
    image: phpmyadmin:latest
    restart: unless-stopped
    environment:
      - PMA_ARBITRARY=1
      # DB table
      - PMA_HOST:db 
      # Root password
      - MYSQL_ROOT_PASSWORD:root 
      # Timezone
      - TZ=Europe/Oslo 
    container_name: poenskelisten-phpmyadmin
    ports:
      - 80:80
    depends_on:
      - db
    networks:
      - db

networks:
  db:
    external: false

FAQ - What u mean??? 😕

What does Pønskelisten mean?
Just a clever Norwegian wordplay that doesn't translate to English at all. A wishlist is called a 'ønskeliste' in Norwegian, and the verb to 'pønske' means to plot and plan. Therefore, Pønskelisten.

Can you please remove the need to manage the DB directly?
Yeah yeah, it's coming.

The End - Does it work? 🪛

Well, this is in early development and making it user-friendly and worth hosting is hard and takes time. It is certainly functional, but it isn't neccasserly what you need or want. Feel free to add feedback or feature requests in the from of GitHub Issues.