From 67e590393bcc1d68660fc4de2cacf7a063d86061 Mon Sep 17 00:00:00 2001 From: grandeljay Date: Tue, 11 Oct 2022 13:07:33 +0200 Subject: [PATCH] Refactor --- README.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 07018fde..cb3849d9 100644 --- a/README.md +++ b/README.md @@ -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! ## :desktop_computer: Screenshots + | Home | 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) ## :heavy_check_mark: Requirements -* Apache or Nginx -* PHP 8.1 - * [intl](https://www.php.net/manual/en/book.intl.php) -* [MJML](https://mjml.io/api) api keys + +- Apache or Nginx +- PHP 8.1 + - [intl](https://www.php.net/manual/en/book.intl.php) +- [MJML](https://mjml.io/api) api keys ## :hammer: Installation ### Git (recommended) + ``` 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. ### 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. @@ -37,19 +41,24 @@ Note: You will have to manually update wishthis by replacing all files with the ## :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 | @@ -58,14 +67,17 @@ Use one of the following commands. | `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 @@ -74,27 +86,32 @@ npx gulp build ``` or as a one-liner + ``` yarn upgrade fomantic-ui && 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` + +- `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 |