Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tglide/to-you
Another to-do app for you, where completing tasks lead to great rewards. Built with Svelte and Appwrite.
https://github.com/tglide/to-you
Last synced: about 1 month ago
JSON representation
Another to-do app for you, where completing tasks lead to great rewards. Built with Svelte and Appwrite.
- Host: GitHub
- URL: https://github.com/tglide/to-you
- Owner: TGlide
- Created: 2022-10-08T20:12:23.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T02:03:30.000Z (over 1 year ago)
- Last Synced: 2024-06-07T08:33:53.493Z (3 months ago)
- Language: CSS
- Homepage: https://to-you-tgl.vercel.app
- Size: 323 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-appwrite - Source Code - you-tgl.vercel.app/) (Showcase (Built with Appwrite 📣) / Svelte)
README
To You
Another to-do app for you, where completing tasks lead to great rewards.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [1. Clone the repo](#1-clone-the-repo)
- [2. Install front-end dependencies](#2-install-front-end-dependencies)
- [3. Setup appwrite instance](#3-setup-appwrite-instance)
- [4. Setup environment variables](#4-setup-environment-variables)
- [5. Setup appwrite database \& collections](#5-setup-appwrite-database--collections)
- [Usage](#usage)
- [Run App](#run-app)
- [Preview](#preview)
- [To-do](#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](https://kit.svelte.dev/)
- Backend
- [Appwrite](https://appwrite.io/)
## 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
```sh
git clone https://github.com/tglide/to-you
cd to-you
```
#### 2. Install front-end dependencies
```sh
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.
```sh
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:
```sh
TODO_COLLECTION_ID
DATABASE_ID
```
## Usage
### Run App
```sh
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!
- [X] Browser session
- [X] Addition progressive enhancement
- [X] Deletion progressive enhancement
- [X] Update progressive enhancement
- [ ] Rewards system
- [ ] Keyboard controls
- [ ] Dark mode