This commit is contained in:
grandeljay 2022-10-11 13:07:33 +02:00
parent 8582e9985c
commit 67e590393b

View file

@ -5,6 +5,7 @@
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! 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 ## :desktop_computer: Screenshots
| Home | Wishlists | | Home | Wishlists |
| ---------------------------------------------------- | ------------------------------------------------------------------- | | ---------------------------------------------------- | ------------------------------------------------------------------- |
| ![Home](/src/assets/img/screenshots/home.png "Home") | ![Wishlists](/src/assets/img/screenshots/wishlists.png "Wishlists") | | ![Home](/src/assets/img/screenshots/home.png "Home") | ![Wishlists](/src/assets/img/screenshots/wishlists.png "Wishlists") |
@ -15,14 +16,16 @@ wishthis is a simple, intuitive and modern wishlist platform to create, manage a
[![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) [![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 ## :heavy_check_mark: Requirements
* Apache or Nginx
* PHP 8.1 - Apache or Nginx
* [intl](https://www.php.net/manual/en/book.intl.php) - PHP 8.1
* [MJML](https://mjml.io/api) api keys - [intl](https://www.php.net/manual/en/book.intl.php)
- [MJML](https://mjml.io/api) api keys
## :hammer: Installation ## :hammer: Installation
### Git (recommended) ### Git (recommended)
``` ```
git clone -b stable https://github.com/grandeljay/wishthis.git . git clone -b stable https://github.com/grandeljay/wishthis.git .
``` ```
@ -30,6 +33,7 @@ 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. 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 ### Manual
Download the code using the [stable branch](https://github.com/grandeljay/wishthis/tree/stable) and upload it to your server. 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. Note: You will have to manually update wishthis by replacing all files with the changes from the `stable` branch.
@ -37,19 +41,24 @@ Note: You will have to manually update wishthis by replacing all files with the
## :trophy: Contributing ## :trophy: Contributing
### As a tester ### As a tester
In the wishthis plattform, navigate to: In the wishthis plattform, navigate to:
1. Account -> Profile 1. Account -> Profile
1. Preferences 1. Preferences
And set your channel to "Release candidate". Make sure to give feedback! And set your channel to "Release candidate". Make sure to give feedback!
### As a translator ### As a translator
https://www.transifex.com/wishthis/wishthis/ https://www.transifex.com/wishthis/wishthis/
### As a developer ### As a developer
Install dependencies Install dependencies
#### Composer #### Composer
Use one of the following commands. Use one of the following commands.
| Command | Description | | Command | Description |
@ -58,14 +67,17 @@ Use one of the following commands.
| `composer install --no-dev` | Install only required dependencies. | | `composer install --no-dev` | Install only required dependencies. |
#### Yarn #### Yarn
Use one of the following commands. Use one of the following commands.
| Command | Description | | Command | Description |
| ---------------| ------------------------- | | -------------- | ------------------------- |
| `yarn install` | Install all dependencies. | | `yarn install` | Install all dependencies. |
#### Updating fomantic-ui #### Updating fomantic-ui
To update fomantic-ui run the following commands To update fomantic-ui run the following commands
``` ```
yarn upgrade yarn upgrade
cd node_modules/fomantic-ui cd node_modules/fomantic-ui
@ -74,27 +86,32 @@ npx gulp build
``` ```
or as a one-liner or as a one-liner
``` ```
yarn upgrade fomantic-ui && cd node_modules/fomantic-ui && npx gulp install && npx gulp build && cd ../.. yarn upgrade fomantic-ui && cd node_modules/fomantic-ui && npx gulp install && npx gulp build && cd ../..
``` ```
#### Theme changes #### Theme changes
``` ```
cd semantic cd semantic
``` ```
And then one of the following commands: And then one of the following commands:
- `gulp build`
- `gulp watch` - `gulp build`
- `gulp watch`
For more information see: https://fomantic-ui.com/introduction/build-tools.html For more information see: https://fomantic-ui.com/introduction/build-tools.html
#### Code style #### Code style
| Language | Style | | Language | Style |
| -------- | --------------------------- | | -------- | --------------------------- |
| PHP | Custom (PSR-12 + WordPress) | | PHP | Custom (PSR-12 + WordPress) |
## :construction: Roadmap ## :construction: Roadmap
| Item | Status | | Item | Status |
| --------------------------------------------------- | ------------------- | | --------------------------------------------------- | ------------------- |
| Add "or similar" option to wishes | Planned | | Add "or similar" option to wishes | Planned |