wishthis/README.md
2022-03-23 14:07:59 +01:00

61 lines
1.9 KiB
Markdown

# wishthis
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)).
![Wishlists](/src/assets/img/screenshots/wishlists.png "Wishlists")
## 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)
## Requirements
* Apache or Nginx (pretty URLs don't work on Nginx)
* PHP 8.1
## 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
## Contributing
### 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. |
#### 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
## Style
### PHP
| Language | Style |
| -------- | ----- |
| PHP | PSR-12 |