mirror of
https://github.com/ThisIsBenny/wishlist-app.git
synced 2025-04-19 23:37:41 +00:00
80 lines
1.6 KiB
Markdown
80 lines
1.6 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 from the wishlist was bought, it can be removed from the list to prevent duplicate purchases.
|
|
|
|
## Demo
|
|
|
|
[](https://codesandbox.io/s/wishlist-app-ycygh3)
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- Support of multiple wishlists
|
|
- 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
|
|
|
|
## Install
|
|
|
|
### Docker Setup
|
|
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.
|
|
|
|
```yaml
|
|
version: '3.7'
|
|
|
|
services:
|
|
wishlist:
|
|
image: thisisbenny/wishlist-app:latest
|
|
environment:
|
|
- API_KEY=TOP_SECRET
|
|
ports:
|
|
- '5000:5000'
|
|
volumes:
|
|
- ./data:/app/data
|
|
```
|
|
|
|
## Development Guide
|
|
|
|
```sh
|
|
npm install
|
|
npx prisma generate
|
|
npx prisma migrate deploy
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
## Other stuff
|
|
|
|
[](https://www.buymeacoffee.com/hierlDev)
|