Skip to content

Mitrichius/WishlistJS

Repository files navigation

Wishlist License: MIT

Wishlist — small pure JS page/application for making public wishlist.

Demo

Features

  • Easy handling of items — no databases, just JSON config
  • Mobile support
  • Multicurrency price
  • Item description
  • Multi-gift flag
  • Items archivation
  • Show archived items if needed

Installation

It's a static html-page with JS/CSS so all you need is some web-server, e.g. nginx or cloud solutions like Netlify or Github Pages.

Getting started

Create new directory for project and open it:

mkdir wishlist
cd wishlist

Run install script:

bash -c "`curl -fsSL https://raw.github.com/mitrichius/WishlistJS/master/remote-install.sh`"  

After it fill in data.js file with your wished items.
Target your webserver to index.html or just open it in browser.

Config (data.js)

Config section

  • image-default — default image for items
  • currency_default — default currency suffix to price value
  • description - optional html code on top of the page (header)
  • show_archived (0/1) - show archived items (with opacity and text strikethrough)

Items section

All parameters except name are optional.

  • name
  • description
  • price (just number)
  • currency
  • tags (array)
  • url
  • image
  • date
  • archived (0 - not archived, 1 - archived)
  • priority - for additional sorting, ASC-order
  • multi - show that item can be gifted several times
  • properties - array of objects with "key" and "value" keys
"properties": [
    {
        "key": "Size",
        "value": "M"
    }
]

Deploy

Selfhosted

Just rsync your directory to the server and configure webserver to this path:
rsync -vrzl --delete ./ <server_name>:/var/www

Nginx config

Netlify

Push your directory to new repository on Github (it could be private).
Go to Netlify and connect this repository. Config already included.

Get app's new version and features

Run this command in your repo: git submodule update --init --remote

Contributing

If you find a bug or have an idea for a feature, feel free to write an issue or make a PR.

TODO

See issues.

Credits

Icons are provided by Icons8:

License

MIT
© Dmitry Kolosov 2020

About

Wishlist — small JS page/application for making public wishlist.

Resources

License

Stars

Watchers

Forks

Packages

No packages published