wishthis/README.md

![wishthis logo](/src/assets/img/logo-readme.svg "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)).

## :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://badgen.net/discord/members/WrUXnpNyza/?label=Discord&color=purple&icon=discord)](https://discord.gg/WrUXnpNyza)
[![Matrix](https://badgen.net/matrix/members/wishthis/matrix.org)](https://matrix.to/#/#wishthis:matrix.org)

## :earth_africa: Available in 28 different languages
| Language             |                  | Country        | Locale  |
| -------------------- | ---------------- | -------------- | ------- |
| Bulgaria             | :bulgaria:       | Bulgaria       | bg_BG   |
| Chinese (Simplified) |                  |                | zh-Hans |
| Czech                | :czech_republic: | Czech Republic | cs_CZ   |
| Danish               | :denmark:        | Denmark        | da_DK   |
| Dutch                | :netherlands:    | Netherlands    | nl_NL   |
| English              | :gb:             | United Kingdom | en_GB   |
| English              | :us:             | United States  | en_US   |
| Estonian             | :estonia:        | Estonia        | et_EE   |
| Finnish              | :finland:        | Finland        | fi_FI   |
| French               | :fr:             | France         | fr_FR   |
| German               | :de:             | Germany        | de_DE   |
| Greek                | :greece:         | Greece         | el_GR   |
| Hungarian            | :hungary:        | Hungary        | hu_HU   |
| Indonesian           | :indonesia:      | Indonesia      | id_ID   |
| Italian              | :it:             | Italy          | it_IT   |
| Japanese             | :jp:             | Japan          | ja_JP   |
| Latvian              | :latvia:         | Latvia         | lv_LV   |
| Lithuanian           | :lithuania:      | Lithuania      | lt_LT   |
| Polish               | :poland:         | Poland         | pl_PL   |
| Portuguese           | :brazil:         | Brazil         | pt_BR   |
| Portuguese           | :portugal:       | Portugal       | pt_PT   |
| Romanian             | :romania:        | Romania        | ro_RO   |
| Russian              | :ru:             | Russia         | ru_RU   |
| Slovak               | :slovakia:       | Slovakia       | ro_RO   |
| Slovenian            | :slovenia:       | Slovenia       | sl_SL   |
| Spanish              | :es:             | Spain          | es_ES   |
| Swedish              | :sweden:         | Sweden         | sv_SE   |
| Turkish              | :tr:             | Turkey         | tr_TR   |

## :heavy_check_mark: Requirements
* Apache or Nginx
* PHP 8.1

## :hammer: Installation

### Git (recommended)
```
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](https://github.com/grandeljay/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.

## :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
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. |

#### NPM
Use one of the following commands.

| Command                                       | Description                         |
| --------------------------------------------- | ----------------------------------- |
| `npm install`                                 | Install all dependencies.           |
| `npm install --only=production --no-optional` | Install only required dependencies. |

#### Yarn
Use one of the following commands.

| Command        | Description               |
| ---------------| ------------------------- |
| `yarn install` | Install all dependencies. |

#### 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) |

## :construction: 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             |
| Price field for wishes                              | Planned             |
| Redirect to original target after login             | Planned             |
| Request more wishes on shared wishlist              | 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 |
Add logo 2022-03-28 07:59:59 +00:00			`![wishthis logo](/src/assets/img/logo-readme.svg "wishthis logo")`

Change heading 2022-03-28 08:01:34 +00:00			`# Make a wish`
Initial commit 2021-11-12 15:23:48 +00:00
Improve wording 2022-03-07 12:55:23 +00:00			`wishthis is a simple, intuitive and modern wishlist platform to create, manage and view`
Update screenshots 2022-01-26 12:35:51 +00:00			`your wishes for any kind of occasion ([demo](https://wishthis.online)).`

Add emoji 2022-04-05 15:37:47 +00:00			`## :desktop_computer: Screenshots`
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
Add chat badges 2022-03-04 10:36:49 +00:00			`[![Discord](https://badgen.net/discord/members/WrUXnpNyza/?label=Discord&color=purple&icon=discord)](https://discord.gg/WrUXnpNyza)`
Fix matrix badge 2022-03-11 07:56:59 +00:00			`[![Matrix](https://badgen.net/matrix/members/wishthis/matrix.org)](https://matrix.to/#/#wishthis:matrix.org)`
Initial commit 2021-11-12 15:23:48 +00:00
Add Lithuanian 2022-06-08 05:35:20 +00:00			`## :earth_africa: Available in 28 different languages`
Add locales 2022-06-08 05:10:10 +00:00			`\| Language \| \| Country \| Locale \|`
			`\| -------------------- \| ---------------- \| -------------- \| ------- \|`
			`\| Bulgaria \| :bulgaria: \| Bulgaria \| bg_BG \|`
			`\| Chinese (Simplified) \| \| \| zh-Hans \|`
			`\| Czech \| :czech_republic: \| Czech Republic \| cs_CZ \|`
			`\| Danish \| :denmark: \| Denmark \| da_DK \|`
			`\| Dutch \| :netherlands: \| Netherlands \| nl_NL \|`
			`\| English \| :gb: \| United Kingdom \| en_GB \|`
			`\| English \| :us: \| United States \| en_US \|`
			`\| Estonian \| :estonia: \| Estonia \| et_EE \|`
			`\| Finnish \| :finland: \| Finland \| fi_FI \|`
			`\| French \| :fr: \| France \| fr_FR \|`
			`\| German \| :de: \| Germany \| de_DE \|`
			`\| Greek \| :greece: \| Greece \| el_GR \|`
			`\| Hungarian \| :hungary: \| Hungary \| hu_HU \|`
			`\| Indonesian \| :indonesia: \| Indonesia \| id_ID \|`
			`\| Italian \| :it: \| Italy \| it_IT \|`
			`\| Japanese \| :jp: \| Japan \| ja_JP \|`
			`\| Latvian \| :latvia: \| Latvia \| lv_LV \|`
Add Lithuanian 2022-06-08 05:35:20 +00:00			`\| Lithuanian \| :lithuania: \| Lithuania \| lt_LT \|`
Add locales 2022-06-08 05:10:10 +00:00			`\| Polish \| :poland: \| Poland \| pl_PL \|`
			`\| Portuguese \| :brazil: \| Brazil \| pt_BR \|`
			`\| Portuguese \| :portugal: \| Portugal \| pt_PT \|`
			`\| Romanian \| :romania: \| Romania \| ro_RO \|`
			`\| Russian \| :ru: \| Russia \| ru_RU \|`
			`\| Slovak \| :slovakia: \| Slovakia \| ro_RO \|`
			`\| Slovenian \| :slovenia: \| Slovenia \| sl_SL \|`
			`\| Spanish \| :es: \| Spain \| es_ES \|`
			`\| Swedish \| :sweden: \| Sweden \| sv_SE \|`
			`\| Turkish \| :tr: \| Turkey \| tr_TR \|`
Add translations 2022-03-25 13:07:06 +00:00
Add emoji 2022-04-05 15:37:47 +00:00			`## :heavy_check_mark: Requirements`
Improve pretty URLs 2022-04-08 13:25:34 +00:00			`* Apache or Nginx`
Improve menu order 2022-03-08 13:39:40 +00:00			`* PHP 8.1`
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)`
Improve installation instructions 2022-03-27 08:22:36 +00:00			```
Improve installation instructions 2022-04-06 14:00:29 +00:00			`git clone -b stable https://github.com/grandeljay/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`
Improve installation instructions 2022-03-28 07:45:50 +00:00			`Download the code using the [stable branch](https://github.com/grandeljay/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
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`
			`In the wishthis plattform, navigate to:`
			`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`
			`https://www.transifex.com/wishthis/wishthis/`

			`### As a developer`
Initial commit 2021-11-12 15:23:48 +00:00			`Install dependencies`
Update README.md 2022-01-13 13:01:19 +00:00
Add translation option 2022-03-23 13:07:59 +00:00			`#### Composer`
Improve contributing instructions 2022-02-22 12:13:53 +00:00			`Use one of the following commands.`

			`\| Command \| Description \|`
			`\| --------------------------- \| ----------------------------------- \|`
			\| `composer install` \| Install all dependencies. \|
			\| `composer install --no-dev` \| Install only required dependencies. \|
Improve development instructions 2022-01-21 08:36:43 +00:00
Add translation option 2022-03-23 13:07:59 +00:00			`#### NPM`
Improve development instructions 2022-01-21 08:36:43 +00:00			`Use one of the following commands.`

Improve contributing instructions 2022-02-22 12:13:53 +00:00			`\| Command \| Description \|`
			`\| --------------------------------------------- \| ----------------------------------- \|`
			\| `npm install` \| Install all dependencies. \|
			\| `npm install --only=production --no-optional` \| Install only required dependencies. \|
Add build instructions 2022-01-13 13:21:29 +00:00
Install yarn 2022-04-08 10:55:35 +00:00			`#### Yarn`
			`Use one of the following commands.`

			`\| Command \| Description \|`
			`\| ---------------\| ------------------------- \|`
			\| `yarn install` \| Install all dependencies. \|

Add translation option 2022-03-23 13:07:59 +00:00			`#### Theme changes`
Add build instructions 2022-01-13 13:21:29 +00:00			```
			`cd semantic`
			```
Improve development instructions 2022-01-21 08:36:43 +00:00
			`And then one of the following commands:`
			- `gulp build`
			- `gulp watch`

Add build instructions 2022-01-13 13:21:29 +00:00			`For more information see: https://fomantic-ui.com/introduction/build-tools.html`
Add style 2022-03-04 10:36:41 +00:00
Move Style section into "As a developer" 2022-04-07 12:15:06 +00:00			`#### Code style`
Edit code stlye 2022-05-29 09:13:30 +00:00			`\| Language \| Style \|`
			`\| -------- \| --------------------------- \|`
			`\| PHP \| Custom (PSR-12 + WordPress) \|`
Add emoji 2022-04-05 15:37:47 +00:00
			`## :construction: Roadmap`
Extend roadmap 2022-04-09 17:07:36 +00:00			`\| Item \| Status \|`
			`\| --------------------------------------------------- \| ------------------- \|`
Extend roadmap 2022-04-12 07:31:03 +00:00			`\| Add "or similar" option to wishes \| Planned \|`
Add is purchasable wish option 2022-04-12 11:05:16 +00:00			`\| Combined/separate (and/or) wishes \| Planned \|`
Merge branch 'develop' of https://github.com/grandeljay/wishthis into develop 2022-04-10 08:27:27 +00:00			`\| Group wishes by store \| Planned \|`
Extend roadmap 2022-04-09 17:07:36 +00:00			`\| Option to show/notify when a wish was fulfilled \| Planned \|`
			`\| Price field for wishes \| Planned \|`
Merge branch 'develop' of https://github.com/grandeljay/wishthis into develop 2022-04-10 08:27:27 +00:00			`\| Redirect to original target after login \| Planned \|`
Extend roadmap 2022-04-12 08:49:47 +00:00			`\| Request more wishes on shared wishlist \| Planned \|`
Extend roadmap 2022-04-09 17:07:36 +00:00			`\| 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 \|`