wishthis/README.md

135 lines
4.6 KiB
Markdown
Raw Normal View History

2022-10-11 11:08:02 +00:00
![wishthis logo](/src/assets/img/logo-readme.svg?v=2 "wishthis logo")
2022-03-28 07:59:59 +00:00
2022-03-28 08:01:34 +00:00
# Make a wish
2021-11-12 15:23:48 +00:00
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!
2022-01-26 12:35:51 +00:00
2022-04-05 15:37:47 +00:00
## :desktop_computer: Screenshots
2022-10-11 11:07:33 +00:00
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") |
2021-11-12 15:23:48 +00:00
2022-04-05 15:37:47 +00:00
## :family_man_man_boy: Join the conversation
2022-01-26 12:03:30 +00:00
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)
2021-11-12 15:23:48 +00:00
2022-04-05 15:37:47 +00:00
## :heavy_check_mark: Requirements
2022-10-11 11:07:33 +00:00
- Apache or Nginx
- PHP 8.1
- [intl](https://www.php.net/manual/en/book.intl.php)
- [MJML](https://mjml.io/api) api keys
2021-11-12 15:23:48 +00:00
2022-04-05 15:37:47 +00:00
## :hammer: Installation
2022-03-27 08:16:13 +00:00
### Git (recommended)
2022-10-11 11:07:33 +00:00
2022-03-27 08:22:36 +00:00
```
2022-04-06 14:00:29 +00:00
git clone -b stable https://github.com/grandeljay/wishthis.git .
2022-03-27 08:22:36 +00:00
```
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
2022-10-11 11:07:33 +00:00
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.
2022-01-18 11:06:43 +00:00
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.
2022-03-27 08:16:13 +00:00
2022-04-05 15:37:47 +00:00
## :trophy: Contributing
2022-03-23 13:07:59 +00:00
2022-04-07 12:13:15 +00:00
### As a tester
2022-10-11 11:07:33 +00:00
2022-04-07 12:13:15 +00:00
In the wishthis plattform, navigate to:
2022-10-11 11:07:33 +00:00
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!
2022-03-23 13:07:59 +00:00
### As a translator
2022-10-11 11:07:33 +00:00
2022-10-11 11:24:44 +00:00
Localisation is currently done via Transifex.
2022-03-23 13:07:59 +00:00
https://www.transifex.com/wishthis/wishthis/
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)
2022-03-23 13:07:59 +00:00
### As a developer
2022-10-11 11:07:33 +00:00
2021-11-12 15:23:48 +00:00
Install dependencies
2022-01-13 13:01:19 +00:00
2022-03-23 13:07:59 +00:00
#### Composer
2022-10-11 11:07:33 +00:00
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. |
2022-01-21 08:36:43 +00:00
2022-04-08 10:55:35 +00:00
#### Yarn
2022-10-11 11:07:33 +00:00
2022-04-08 10:55:35 +00:00
Use one of the following commands.
| Command | Description |
2022-10-11 11:07:33 +00:00
| -------------- | ------------------------- |
2022-04-08 10:55:35 +00:00
| `yarn install` | Install all dependencies. |
#### Updating fomantic-ui
2022-10-11 11:07:33 +00:00
To update fomantic-ui run the following commands
2022-10-11 11:07:33 +00:00
```
yarn upgrade
cd node_modules/fomantic-ui
npx gulp install
npx gulp build
```
or as a one-liner
2022-10-11 11:07:33 +00:00
```
2022-10-03 13:13:11 +00:00
yarn upgrade fomantic-ui && cd node_modules/fomantic-ui && npx gulp install && npx gulp build && cd ../..
```
2022-03-23 13:07:59 +00:00
#### Theme changes
2022-10-11 11:07:33 +00:00
2022-01-13 13:21:29 +00:00
```
cd semantic
```
2022-01-21 08:36:43 +00:00
And then one of the following commands:
2022-10-11 11:07:33 +00:00
- `gulp build`
- `gulp watch`
2022-01-21 08:36:43 +00:00
2022-01-13 13:21:29 +00:00
For more information see: https://fomantic-ui.com/introduction/build-tools.html
2022-03-04 10:36:41 +00:00
#### Code style
2022-10-11 11:07:33 +00:00
2022-05-29 09:13:30 +00:00
| Language | Style |
| -------- | --------------------------- |
| PHP | Custom (PSR-12 + WordPress) |
2022-04-05 15:37:47 +00:00
## :construction: Roadmap
2022-10-11 11:07:33 +00:00
2022-04-09 17:07:36 +00:00
| Item | Status |
| --------------------------------------------------- | ------------------- |
2022-04-12 07:31:03 +00:00
| Add "or similar" option to wishes | Planned |
2022-04-12 11:05:16 +00:00
| Combined/separate (and/or) wishes | Planned |
| Group wishes by store | Planned |
2022-04-09 17:07:36 +00:00
| Option to show/notify when a wish was fulfilled | Planned |
| Redirect to original target after login | Planned |
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 |