mirror of
https://github.com/ThisIsBenny/wishlist-app.git
synced 2025-04-19 15:27:41 +00:00
Update README.md
This commit is contained in:
parent
87039c6e35
commit
45da3ba0b0
1 changed files with 8 additions and 11 deletions
19
README.md
19
README.md
|
@ -2,9 +2,9 @@
|
||||||
|
|
||||||
The wishlist app is a simple webapp for publishing wishlists. It allows to share wishlists for different people or occasions with friends and family. If something from the wishlist was bought, it can be removed from the list to prevent duplicate purchases.
|
The wishlist app is a simple webapp for publishing wishlists. It allows to share wishlists for different people or occasions with friends and family. If something from the wishlist was bought, it can be removed from the list to prevent duplicate purchases.
|
||||||
|
|
||||||
[](https://codesandbox.io/s/wishlist-app-h0htfc)
|
## Demo
|
||||||
|
|
||||||
The app can be easily self-hosted via Docker (see docker-compose example below).
|
[](https://codesandbox.io/s/wishlist-app-ycygh3)
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
@ -14,17 +14,14 @@ The app can be easily self-hosted via Docker (see docker-compose example below).
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Support of multiple wishlists
|
- Support of multiple wishlists
|
||||||
- Items can be removed from the wishlist by users
|
- Items can be removed from the wishlist by anonymous users
|
||||||
|
- Grab title, description and image-url from url via open graph meta tags
|
||||||
- i18n support
|
- i18n support
|
||||||
|
|
||||||
## Feature Roadmap
|
## Install
|
||||||
|
|
||||||
- Administrate wishlists
|
### Docker Setup
|
||||||
- Grab title, description and image-url from url via open graph meta tags
|
The app can be easily installed via Docker compose. During installation, only a password (API key) and a path for the SQLite database must be specified.
|
||||||
- Login
|
|
||||||
- Image upload
|
|
||||||
|
|
||||||
## Docker Setup
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
version: '3.7'
|
version: '3.7'
|
||||||
|
@ -40,7 +37,7 @@ services:
|
||||||
- ./data:/app/data
|
- ./data:/app/data
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development Setup
|
## Development Guide
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install
|
npm install
|
||||||
|
|
Loading…
Add table
Reference in a new issue