wishthis/README.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

2021-11-12 15:23:48 +00:00
# wishthis
2022-03-07 12:55:23 +00:00
wishthis is a simple, intuitive and modern wishlist platform to create, manage and view
2022-01-26 12:35:51 +00:00
your wishes for any kind of occasion ([demo](https://wishthis.online)).
2022-02-25 13:57:16 +00:00
![Wishlists](/src/assets/img/screenshots/wishlists.png "Wishlists")
2021-11-12 15:23:48 +00:00
2022-03-04 10:36:49 +00:00
## Join the conversation
2022-01-26 12:03:30 +00:00
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)
2022-03-04 10:37:45 +00:00
[![Matrix](https://badgen.net/matrix/members/wishthis/matrix.org/?label=Matrix&color=purple)](https://matrix.to/#/#wishthis:matrix.org)
2021-11-12 15:23:48 +00:00
## Requirements
2022-03-08 13:39:40 +00:00
* PHP 8.1
2021-11-12 15:23:48 +00:00
2022-01-18 11:06:43 +00:00
## Installation
1. Download the latest [release](https://github.com/grandeljay/wishthis/releases) and upload all files to your server
1. Follow the instructions of the installer
2021-11-12 15:23:48 +00:00
## Contributing
Install dependencies
2022-01-13 13:01:19 +00:00
2022-01-21 08:36:43 +00:00
### Composer
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
### NPM
Use one of the following commands.
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. |
2022-01-13 13:21:29 +00:00
### Theme changes
```
cd semantic
```
2022-01-21 08:36:43 +00:00
And then one of the following commands:
- `gulp build`
- `gulp watch`
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
## Style
### PHP
| Language | Style |
| -------- | ----- |
| PHP | PSR-12 |