mirror of
https://github.com/ThisIsBenny/wishlist-app.git
synced 2025-04-19 23:37:41 +00:00
68 lines
1.1 KiB
Markdown
68 lines
1.1 KiB
Markdown
# wishlist
|
|
|
|
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 was bought from the wishlist, it can be removed from the list to prevent duplicate purchases.
|
|
|
|
The app can be easily self-hosted via Docker (see docker-compose example below).
|
|
|
|
## Features
|
|
|
|
- Support of multiple wishlists
|
|
- Items can be removed from the wishlist by users
|
|
- i18n support
|
|
|
|
## Feature Roadmap
|
|
|
|
- Administrate wishlists
|
|
- Grab title, description and image-url from url via open graph meta tags
|
|
- Login
|
|
- Image upload
|
|
|
|
## Docker Setup
|
|
|
|
```yaml
|
|
version: '3.7'
|
|
|
|
services:
|
|
wishlist:
|
|
image: thisisbenny/wishlist-app:latest
|
|
ports:
|
|
- '5000:5000'
|
|
volumes:
|
|
- ./data:/app/data
|
|
```
|
|
|
|
## Development Setup
|
|
|
|
```sh
|
|
npm install && npm run prepare
|
|
```
|
|
|
|
### Compile and Hot-Reload for Development
|
|
|
|
```sh
|
|
npm run dev
|
|
```
|
|
|
|
### Type-Check, Compile and Minify for Production
|
|
|
|
```sh
|
|
npm run build
|
|
```
|
|
|
|
### Run Unit Tests
|
|
|
|
```sh
|
|
npm run test:unit
|
|
```
|
|
|
|
### Lint
|
|
|
|
```sh
|
|
npm run lint
|
|
```
|
|
|
|
### Typecheck
|
|
|
|
```sh
|
|
npm run typecheck
|
|
```
|