wishthis/README.md

![wishthis logo](/src/assets/img/logo-readme.svg?v=2 "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](https://wishthis.online)). Currently, wishthis is available in **99** different locales!

## :desktop_computer: Screenshots

| Home                                                 | Wishlists                                                           |
| ---------------------------------------------------- | ------------------------------------------------------------------- |
| ![Home](/src/assets/img/screenshots/home.png "Home") | ![Wishlists](/src/assets/img/screenshots/wishlists.png "Wishlists") |

## :family_man_man_boy: Join the conversation

[![Discord](https://img.shields.io/discord/935867122729496616?color=6435c9&label=Discord&logo=discord&logoColor=%23fff&style=for-the-badge)](https://discord.gg/WrUXnpNyza)
[![Matrix](https://img.shields.io/matrix/wishthis:matrix.org?color=6435c9&label=Matrix&logo=matrix&logoColor=%23fff&style=for-the-badge)](https://matrix.to/#/#wishthis:matrix.org)

## :heavy_check_mark: Requirements

-   Apache or Nginx
-   PHP 8.1 - PHP 8.2
    -   [intl](https://www.php.net/manual/en/book.intl.php)
-   MySQL/MariaDB
-   [MJML](https://mjml.io/api) api keys (not required and used for rendering emails. Make sure [sendmail](https://www.php.net/manual/en/mail.configuration.php) is configured properly.)

## :hammer: Installation

### Git (recommended)

```
git clone -b stable https://github.com/wishthis/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](https://github.com/wishthis/wishthis/tree/stable) 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.

### Note

Make sure wishthis is setup via a domain directly and not running inside a sub-folder.

## :trophy: Contributing

### As a tester

In the wishthis plattform, navigate to:

1. Account -> Profile
1. Preferences

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

### As a translator

Localisation is currently done via Transifex.

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

### As a sponsor

Time spent on wishthis is time not doing for-profit work. Of course there is no expectation but if you would still like to show your appreciation, you can here. It is very appreciated!

[![GitHub Sponsors](https://img.shields.io/github/sponsors/grandeljay?color=6435c9&logo=githubsponsors&logoColor=fff&style=for-the-badge)](https://github.com/sponsors/grandeljay)

### As a developer

To setup your development environment you currently have two possibilities:

1. Git

    Clone this repository and you're good to go!

1. Docker

    An official Docker image is also available: https://github.com/wishthis/docker. It's created and maintained by [Hiobi](https://github.com/Hiobi), thanks!

#### Updating

##### Fomantic-UI

After updating the `fomantic-ui` dependency, you can rebuild all assets like this:

```
$ cd ./node_modules/fomantic-ui
$ npx gulp build
```
Update logo path 2022-10-11 11:08:02 +00:00			`![wishthis logo](/src/assets/img/logo-readme.svg?v=2 "wishthis logo")`
Add logo 2022-03-28 07:59:59 +00:00
Change heading 2022-03-28 08:01:34 +00:00			`# Make a wish`
Initial commit 2021-11-12 15:23:48 +00:00
Remove table of locales 2022-09-29 09:47:37 +00:00			`wishthis is a simple, intuitive and modern wishlist platform to create, manage and view your wishes for any kind of occasion ([demo](https://wishthis.online)). Currently, wishthis is available in 99 different locales!`
Update screenshots 2022-01-26 12:35:51 +00:00
Add emoji 2022-04-05 15:37:47 +00:00			`## :desktop_computer: Screenshots`
Refactor 2022-10-11 11:07:33 +00:00
Update screenshots 2022-03-28 07:56:19 +00:00			`\| Home \| Wishlists \|`
			`\| ---------------------------------------------------- \| ------------------------------------------------------------------- \|`
			`\| ![Home](/src/assets/img/screenshots/home.png "Home") \| ![Wishlists](/src/assets/img/screenshots/wishlists.png "Wishlists") \|`
Initial commit 2021-11-12 15:23:48 +00:00
Add emoji 2022-04-05 15:37:47 +00:00			`## :family_man_man_boy: Join the conversation`
Add discord link 2022-01-26 12:03:30 +00:00
Fix badge links 2022-09-30 14:21:25 +00:00			`[![Discord](https://img.shields.io/discord/935867122729496616?color=6435c9&label=Discord&logo=discord&logoColor=%23fff&style=for-the-badge)](https://discord.gg/WrUXnpNyza)`
			`[![Matrix](https://img.shields.io/matrix/wishthis:matrix.org?color=6435c9&label=Matrix&logo=matrix&logoColor=%23fff&style=for-the-badge)](https://matrix.to/#/#wishthis:matrix.org)`
Initial commit 2021-11-12 15:23:48 +00:00
Add emoji 2022-04-05 15:37:47 +00:00			`## :heavy_check_mark: Requirements`
Refactor 2022-10-11 11:07:33 +00:00
			`- Apache or Nginx`
docs: add php 8.2 as compatible 2023-08-30 09:56:38 +00:00			`- PHP 8.1 - PHP 8.2`
Refactor 2022-10-11 11:07:33 +00:00			`- [intl](https://www.php.net/manual/en/book.intl.php)`
📝 — Add MySQL/MariaDB to requirements 2023-01-20 13:37:47 +00:00			`- MySQL/MariaDB`
Add a mention that sendmail needs to be configured 2022-11-09 11:40:19 +00:00			`- [MJML](https://mjml.io/api) api keys (not required and used for rendering emails. Make sure [sendmail](https://www.php.net/manual/en/mail.configuration.php) is configured properly.)`
Initial commit 2021-11-12 15:23:48 +00:00
Add emoji 2022-04-05 15:37:47 +00:00			`## :hammer: Installation`
Improve install/update instructions 2022-03-27 08:16:13 +00:00
			`### Git (recommended)`
Refactor 2022-10-11 11:07:33 +00:00
Improve installation instructions 2022-03-27 08:22:36 +00:00			```
docs: fix old repository link 2023-09-20 10:36:06 +00:00			`git clone -b stable https://github.com/wishthis/wishthis.git .`
Improve installation instructions 2022-03-27 08:22:36 +00:00			```
Improve install/update instructions 2022-03-27 08:16:13 +00:00
			`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`
Refactor 2022-10-11 11:07:33 +00:00
docs: fix old repository link 2023-09-20 10:36:06 +00:00			`Download the code using the [stable branch](https://github.com/wishthis/wishthis/tree/stable) and upload it to your server.`
Add installation instructions 2022-01-18 11:06:43 +00:00
Improve installation instructions 2022-03-28 07:45:50 +00:00			Note: You will have to manually update wishthis by replacing all files with the changes from the `stable` branch.
Improve install/update instructions 2022-03-27 08:16:13 +00:00
docs: add note about running wishthis inside a sub-folder 2023-09-12 05:41:27 +00:00			`### Note`

			`Make sure wishthis is setup via a domain directly and not running inside a sub-folder.`

Add emoji 2022-04-05 15:37:47 +00:00			`## :trophy: Contributing`
Add translation option 2022-03-23 13:07:59 +00:00
Extend contributing instructions 2022-04-07 12:13:15 +00:00			`### As a tester`
Refactor 2022-10-11 11:07:33 +00:00
Extend contributing instructions 2022-04-07 12:13:15 +00:00			`In the wishthis plattform, navigate to:`
Refactor 2022-10-11 11:07:33 +00:00
Extend contributing instructions 2022-04-07 12:13:15 +00:00			`1. Account -> Profile`
			`1. Preferences`

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

Add translation option 2022-03-23 13:07:59 +00:00			`### As a translator`
Refactor 2022-10-11 11:07:33 +00:00
Add "As a translator" description 2022-10-11 11:24:44 +00:00			`Localisation is currently done via Transifex.`

Add translation option 2022-03-23 13:07:59 +00:00			`https://www.transifex.com/wishthis/wishthis/`

Add "As a sponsor section" 2022-10-11 11:24:33 +00:00			`### As a sponsor`

			`Time spent on wishthis is time not doing for-profit work. Of course there is no expectation but if you would still like to show your appreciation, you can here. It is very appreciated!`

			`[![GitHub Sponsors](https://img.shields.io/github/sponsors/grandeljay?color=6435c9&logo=githubsponsors&logoColor=fff&style=for-the-badge)](https://github.com/sponsors/grandeljay)`

Add translation option 2022-03-23 13:07:59 +00:00			`### As a developer`
Refactor 2022-10-11 11:07:33 +00:00
Update README.md 2022-10-12 17:43:59 +00:00			`To setup your development environment you currently have two possibilities:`
Update README.md 2022-01-13 13:01:19 +00:00
Update README.md 2022-10-12 17:43:59 +00:00			`1. Git`
Refactor 2022-10-11 11:07:33 +00:00
Update README.md 2022-10-12 17:43:59 +00:00			`Clone this repository and you're good to go!`
Improve contributing instructions 2022-02-22 12:13:53 +00:00
Update README.md 2022-10-12 17:43:59 +00:00			`1. Docker`
Improve development instructions 2022-01-21 08:36:43 +00:00
docs: make docker image official 2023-09-20 10:38:21 +00:00			`An official Docker image is also available: https://github.com/wishthis/docker. It's created and maintained by [Hiobi](https://github.com/Hiobi), thanks!`
docs(readme): add `fomantic-ui` update instructions 2023-12-19 14:41:07 +00:00
			`#### Updating`

			`##### Fomantic-UI`

docs: fix code formatting 2024-01-08 12:37:58 +00:00			After updating the `fomantic-ui` dependency, you can rebuild all assets like this:
docs(readme): add `fomantic-ui` update instructions 2023-12-19 14:41:07 +00:00
			```
			`$ cd ./node_modules/fomantic-ui`
			`$ npx gulp build`
			```