To You

Another to-do app for you, where completing tasks lead to great rewards.

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
    • 1. Clone the repo
    • 2. Install front-end dependencies
    • 3. Setup appwrite instance
    • 4. Setup environment variables
    • 5. Setup appwrite database & collections
• Usage
  • Run App
  • Preview
• To-do

About The Project

This is a to-do app where you can add simple tasks, that are associated with points, and rewards, that are unlocked with the points you earn.

Built With

• Frontend
  • Svelte Kit
• Backend
  • Appwrite

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

yarn and docker installed on your local machine.

Installation

1. Clone the repo

git clone https://github.com/tglide/to-you
cd to-you

2. Install front-end dependencies

yarn

3. Setup appwrite instance

Head over to https://appwrite.io/docs/installation and follow the instructions to setup appwrite on your local machine. You'll also need to install the Appwrite CLI.

After that, create a new project, and create an API key.

4. Setup environment variables

You'll need to setup the following environment variables in a .env file in the root directory.

APPWRITE_ENDPOINT
APPWRITE_PROJECT_ID
APPWRITE_API_KEY

5. Setup appwrite database & collections

Run the aw:local script to setup the appwrite CLI, then run the aw:deploy script to deploy the collections and database. Setup the rest of the environment variables in the .env file:

TODO_COLLECTION_ID
DATABASE_ID

Usage

Run App

yarn dev

Preview

You can check out a live preview at: https://to-you-peach.vercel.app/

To-do

A to-do app repo wouldn't be complete without it's own to-do list!

• Browser session
• Addition progressive enhancement
• Deletion progressive enhancement
• Update progressive enhancement
• Rewards system
• Keyboard controls
• Dark mode