https://github.com/adityaoberai/.net-appwrite-todo-api

Todo CRUD API built with Appwrite + .NET
https://github.com/adityaoberai/.net-appwrite-todo-api

api appwrite appwrite-database crud dotnet

Last synced: 24 days ago
JSON representation

Todo CRUD API built with Appwrite + .NET

• Host: GitHub
• URL: https://github.com/adityaoberai/.net-appwrite-todo-api
• Owner: adityaoberai
• License: bsd-3-clause
• Created: 2023-07-07T10:07:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-04T12:00:16.000Z (over 1 year ago)
• Last Synced: 2024-10-30T10:47:31.850Z (2 months ago)
• Topics: api, appwrite, appwrite-database, crud, dotnet
• Language: C#
• Homepage: https://dotnet-appwrite-todo.azurewebsites.net/swagger
• Size: 955 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# .NET + Appwrite Todo API

## Description

Todo CRUD API built with Appwrite Cloud and .NET 7

## Installation

### Appwrite Setup

- Sign up for [Appwrite Cloud](https://cloud.appwrite.io/register)

  ![Register for Appwrite Cloud](./Images/RegisterAppwriteCloud.png)

- Create your first project

  ![Create a project](./Images/CreateNewProject.png)

- Create an API Key with the scopes `documents.read` and `documents.write`

  ![API Key scopes](./Images/APIKeyScopes.png)

- Create a database, followed by a collection, and create the following attributes

    | Attribute ID | Type    | Size | Default Value | Required | Array |

    |--------------|---------|------|---------------|----------|-------|

    | description  | string  | 255  |               | Yes      | No    |

    | isCompleted  | boolean |      |               | Yes      | No    |

    ![Collection attributes](./Images/DatabaseAttributes.png)

  

- Keep your Project Id, Database Id, Collection Id, and API Key saved for the project setup

### Project Setup

- Install the [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download) if you haven't already

- Clone the repository

  ```sh

  https://github.com/adityaoberai/.NET-Appwrite-Todo-API.git

  ```

- Restore all NuGet packages

  ```sh

  dotnet restore

  ```

- Enter the project directory

  ```sh

  cd AppwriteCrudApi/

  ```

- Add the Project Id, Database Id, Collection Id, and API Key you saved from your Appwrite project in the `appsettings.json` file

- Run the project

  ```sh

  dotnet run

  ```

- Open the following URL in your browser

  ```

  https://localhost:7248/swagger

  ```

  

  OR

  ```

  http://localhost:5023/swagger

  ```