Skip to content
This repository has been archived by the owner on Jan 26, 2024. It is now read-only.

docs: Add note on Document Level Security in Readme #70

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Add note on Document Level Security in Readme #70

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f05399
Add note on Document Level Security
adityaoberai Aug 14, 2023
34c0f02
Update images to show current Appwrite Cloud UI
adityaoberai Aug 16, 2023
382d867
Grammatical fixes
adityaoberai Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,29 @@ Follow our simple [Installation Guide](https://appwrite.io/docs/installation) to
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, <project-name>.vercel.app etc`)
![Create Web App](https://user-images.githubusercontent.com/20852629/113019434-3c27c900-919f-11eb-997c-1da5a8303ceb.png)
![Create Web App](https://github.com/appwrite/demo-todo-with-react/assets/31401437/13362aa5-7a15-444c-96a7-48ac60647e16)

2. Create a new collection with the following properties
2. Create a new database and collection with the following properties
* **Attributes**
*

Add the following attributes to the collection.
> Make sure that your Attribute ID exactly matches the key in the images

<p align="center">
<img width="744" alt="Content Attribute" src="https://user-images.githubusercontent.com/29069505/155617343-6ff674b3-9809-42ac-8175-0f76271b1189.png">
<img width="744" alt="Content Attribute" src="https://github.com/appwrite/demo-todo-with-react/assets/31401437/b263fc46-a999-4703-842c-d7b3b02f31f6">
</p>

<p align="center">
<img width="744" alt="IsComplete Attribute" src="https://user-images.githubusercontent.com/29069505/155617393-f30270af-aa07-4392-a7b2-75b8ce9c60da.png">
<img width="744" alt="IsComplete Attribute" src="https://github.com/appwrite/demo-todo-with-react/assets/31401437/71f4cf6f-8529-4c8a-b86a-dfb2cfca444a">
</p>

* **Permissions**

Add the following permissions to your collections. These permissions ensure that only registered users can access the collection.

<p align="center">
<img src="https://user-images.githubusercontent.com/20852629/113019801-99bc1580-919f-11eb-9a94-13b1529cb925.png" alt="Collection Permissions" width="400"/>
</p>
Ensure that you also enable **Document Level Security** in the settings.

![Document Level Security](https://github.com/appwrite/demo-todo-with-react/assets/31401437/072b89cb-07de-42a4-ad12-17c348a786e4)

### 🚀 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.
Expand Down Expand Up @@ -76,7 +76,7 @@ Run the following command to generate your `.env` vars
$ cp .env.example .env
```

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

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

Expand Down