https://github.com/sooraj-s-98/todo-with-svelte

https://github.com/sooraj-s-98/todo-with-svelte

appwrite hacktoberfest hacktoberfest2022 svelte sveltejs

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sooraj-s-98/todo-with-svelte
• Owner: Sooraj-s-98
• License: mit
• Created: 2022-10-04T13:21:25.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-31T15:14:00.000Z (about 2 years ago)
• Last Synced: 2024-10-31T21:21:33.244Z (about 2 months ago)
• Topics: appwrite, hacktoberfest, hacktoberfest2022, svelte, sveltejs
• Language: Svelte
• Homepage:
• Size: 53.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 🔖 Todo With Svelte

A simple todo app built with Appwrite and Svelte

If you simply want to try out the App, go ahead and check out the demo at https://todo-with-svelte.up.railway.app/

https://user-images.githubusercontent.com/52352285/196016987-42fd4eeb-b8b1-4751-8cca-49cd8ec312f8.mov

We need to make a few configuration changes to your Appwrite server.

1. Add a new Web App in Appwrite and enter the endpoint of your website (localhost, .vercel.app etc)



2. Create a new collection with the following properties



3. Add the following permissions to your collection.



## 🎬 Getting Started

### 🤘 Install Appwrite 

Follow our simple [Installation Guide](https://appwrite.io/docs/installation) to get Appwrite up and running in no time. You can either deploy Appwrite on your local machine or, on any cloud provider of your choice. 

> Note: If you setup Appwrite on your local machine, you will need to create a public IP so that your hosted frontend can access it.

  

We need to make a few configuration changes to your Appwrite server. 

### 🚀 Deploy the Front End

You have two options to deploy the front-end and we will cover both of them here. In either case, you will need to fill in these environment variables that help your frontend connect to Appwrite.

* VITE_APP_ENDPOINT - Your Appwrite endpoint

* VITE_APP_PROJECT - Your Appwrite project ID

* VITE_APP_COLLECTION_ID - Your Appwrite collection ID 

* VITE_APP_DATABASE_ID - Your Appwrite database ID

### **Run locally**

Follow these instructions to run the demo app locally

```sh

$ git clone https://github.com/Sooraj-s-98/todo-with-svelte

$ cd todo-with-svelte

```

Run the following command to generate your `.env` vars  

```sh

$ cp .env.example .env

```

Now fill in the envrionment variables we discussed above in your `.env`

Now run the following commands and you should be good to go 💪🏼 

```

$ npm install

$ npm run dev

```