Skip to content

JackBailey/Readyto.gift

Repository files navigation

Wishlist

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 is a good alternative, for this, and this is inspired by it. However, it was a little buggy and I wanted a few things done in a different, more opinionated 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.
    • wakatime

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.

Project initialisation

Install dependencies for this project:

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.

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

pnpm install

Compile and Hot-Reload for Development

pnpm dev

Compile and Minify for Production

pnpm build

Format with Prettier and lint with ESLint

pnpm format && pnpm lint