Skip to content

Commit

Permalink
add app screenshots to readme (#158)
Browse files Browse the repository at this point in the history
  • Loading branch information
cmintey authored Nov 8, 2024
1 parent 841def6 commit f06e606
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,23 @@ Wishlist is a self-hosted wishlist application that you can share with your frie
- [x] Invite users via email (SMTP configuration required)
- [x] Options for [suggestions](#suggestions)
- [x] PWA Support
- [x] Group support
- [x] Registry Mode
- [ ] Draw names for a "secret santa" experience
- [x] Multiple groups
- [x] Registry Mode (single list)

<p float="left">
<img src="./assets/homepage-desktop.png" width="74%" />
<img src="./assets/homepage-mobile.png" width="25%" />
Multiple groups for friends and family
</p>

<p float="left">
<img src="./assets/my-wishes-mobile.png" width="49%" />
<img src="./assets/wishes-mobile.png" width="49%" />
Add items to your list so other's can claim them
</p>

<img src="./assets/wish-form.png" />
Create a wish from a URL, or manually fill in the details

## Getting Started

Expand Down Expand Up @@ -49,6 +63,12 @@ You can now connect to your application at `http://<host>:3280`.
>
> Set the `ORIGIN` environment variable to the url you will be connecting to, otherwise you will experience issues
### Environment Variables

`ORIGIN`: The URL your users will connect to e.g. `https://wishlist.domain.com`
`TOKEN_TIME`: The amount of time (hours) that signup and password reset tokens are valid for
`DEFAULT_CURRENCY`: The global default currency to be used. Currency can still be changed on a per-item basis

## Groups

Wishlist has support for multiple wishlist groups. For example, you can have one group for friends and one for family. The wishes on these lists will be completely separate. You can switch between groups using the menu when you click on your profile picture.
Expand Down
Binary file added assets/homepage-desktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/homepage-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/my-wishes-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/wish-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/wishes-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f06e606

Please sign in to comment.