wishthis/README.md

53 lines
1.6 KiB
Markdown
Raw Normal View History

2021-11-12 15:23:48 +00:00
# wishthis
2022-01-26 12:24:48 +00:00
wishthis is a simple, intuitive and modern 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)).
![View wishlist](/src/assets/img/wishlist-view.png "View wishlist")
2021-11-12 15:23:48 +00:00
2022-02-25 09:36:33 +00:00
Join the conversation on:
* [Discord](https://discord.gg/WrUXnpNyza)
* [Matrix](https://matrix.to/#/#wishthis:matrix.org)
2022-01-26 12:03:30 +00:00
2022-01-14 09:03:16 +00:00
## Warning
wishthis is a work in progress and may break at any time. Do not rely on it and make sure you have backups of your data.
Use at your own risk.
2021-11-12 15:23:48 +00:00
## Requirements
* PHP 8
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