wishthis/README.md
2022-09-30 16:21:25 +02:00

4.1 KiB

wishthis logo

Make a wish

wishthis is a simple, intuitive and modern wishlist platform to create, manage and view your wishes for any kind of occasion (demo). Currently, wishthis is available in 99 different locales!

🖥️ Screenshots

Home Wishlists
Home Wishlists

👨‍👨‍👦 Join the conversation

Discord Matrix

✔️ Requirements

  • Apache or Nginx
  • PHP 8.1
  • MJML api keys

🔨 Installation

git clone -b stable https://github.com/grandeljay/wishthis.git .

Note: after pulling updates for a new version you might be prompted to update the database schema in the wishthis user interface (if necessary). Make sure you are logged in.

Manual

Download the code using the stable branch and upload it to your server.

Note: You will have to manually update wishthis by replacing all files with the changes from the stable branch.

🏆 Contributing

As a tester

In the wishthis plattform, navigate to:

  1. Account -> Profile
  2. Preferences

And set your channel to "Release candidate". Make sure to give feedback!

As a translator

https://www.transifex.com/wishthis/wishthis/

As a developer

Install dependencies

Composer

Use one of the following commands.

Command Description
composer install Install all dependencies.
composer install --no-dev Install only required dependencies.

Yarn

Use one of the following commands.

Command Description
yarn install Install all dependencies.

Updating fomantic-ui

To update fomantic-ui run the following commands

yarn upgrade
cd node_modules/fomantic-ui
npx gulp install
npx gulp build

or as a one-liner

yarn upgrade && cd node_modules/fomantic-ui && npx gulp install && npx gulp build && cd ../..

Theme changes

cd semantic

And then one of the following commands:

  • gulp build
  • gulp watch

For more information see: https://fomantic-ui.com/introduction/build-tools.html

Code style

Language Style
PHP Custom (PSR-12 + WordPress)

🚧 Roadmap

Item Status
Add "or similar" option to wishes Planned
Combined/separate (and/or) wishes Planned
Group wishes by store Planned
Option to show/notify when a wish was fulfilled Planned
Redirect to original target after login Planned
Activity feed and friends Under consideration
Browser extension to quickly create wishes from url Under consideration
Bulk add wishes via link list Under consideration
Folders / Subcategories for wishlists Under consideration
Synchronise Steam wishlist Under consideration