https://github.com/JackBailey/Wishlist
https://github.com/JackBailey/Wishlist
appwrite wishlist wishlistproject
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/JackBailey/Wishlist
- Owner: JackBailey
- Created: 2024-06-26T14:25:48.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-03-07T22:32:56.000Z (3 months ago)
- Last Synced: 2025-03-09T04:01:50.830Z (3 months ago)
- Topics: appwrite, wishlist, wishlistproject
- Language: Vue
- Homepage: https://readyto.gift
- Size: 6.35 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-appwrite - Source Code
README
# Readyto.gift
![list with 1 item]()
![list of lists with 1 list]()
This is a simple Wishlist app, to keep track of things you'd like. If anyone buys you anything from it, they can mark it down as such, so you don't get duplicates.
## Why did I make this?
- Amazon wishlists are very limited
- A google doc or notion page lacks a few features, like the author not knowing what has been purchased
- [wishthis](https://github.com/wishthis/wishthis) is a good alternative for this, and this was inspired by it. However, I liked a few things to be done in a different way.
## Stack
- Frontend: Vue (w/ Vite) + Pinia + Vuetify
- Familiar, nicely reactive and wanted to try out something like Vuetify - also means I didn't need to design this beforehand.
- This isn't the most performant app. I could've gone with a more efficient setup, maybe making use of SSR, but this is a simple app that I'll only use a few times a year.
- Backend: Appwrite
- It's a decent backend that I've wanted to use properly for a while and I didn't want to spend an eternity setting one up myself for this project.
## Features
- Multiple users
- Multiple lists
- Items can be marked as purchased
- Author can choose to see what has been purchased or not
- Multiple currency support (whatever Appwrite supports), can be set per list
# Setup
## Installation
Get Appwrite running. You can do this by following the instructions on the [Appwrite website](https://appwrite.io/docs/installation).
## Project initialisation
Install dependencies for this project:
```sh
pnpm install
```
> [!NOTE]
> It might make more sense using appwrite-cli for this, using appwrite.json. I wasn't aware of it when I made the setup script, which is now outdated.
Create a new project within Appwrite, and create a new API key. Subsitute the values in the below command with your API key and Project ID. Replace the endpoint if using your own instance.
```sh
pnpm run setup --key=YOUR-API-KEY --project=YOUR-PROJECT-ID --endpoint=https://cloud.appwrite.io/v1
```
This will then go through and set up the collections you need. You then need to set up the authentication settings depending on your preferences.
Then, move the created `output.env` file to `.env`.
You can also set the below options in the `.env` file:
- `VITE_LOGIN_METHODS`: github,password
- Currently only supports the above options. Both need to be set up within Appwrite.
- `VITE_UMAMI_URL`: https://analytics.example.com/script.js
- `VITE_UMAMI_ID`: f79676da-d2c5-49dd-a35b-f829764b44c5
- `VITE_UMAMI_DOMAINS`: example.com
## Appwrite App config
Then, create a "Web" app within Appwrite, to your liking.
It should then all be set up and ready to go.
Just build it and deploy it to wherever you want. It doesn't need any backup setup (other than Appwrite), but you will need SPA support for vue-router.
## Project Setup
```sh
pnpm install
```
### Compile and Hot-Reload for Development
```sh
pnpm dev
```
### Compile and Minify for Production
```sh
pnpm build
```
### Format with [Prettier](https://prettier.io/) and lint with [ESLint](https://eslint.org/)
```sh
pnpm format && pnpm lint
```