Merge branch 'main' into iamYashSinha-patch-1

Real-Dev-Squad · May 15, 2023 · da3a902 · da3a902
2 parents 2aff090 + bbaaa0b
commit da3a902
Show file tree

Hide file tree

Showing 2 changed files with 131 additions and 1 deletion.
diff --git a/progress/README.md b/progress/README.md
@@ -0,0 +1,46 @@
+# Firestore Standup collection data model
+
+```json
+{
+  "id": "Unique identifier for the document. (String)",
+  "type": "Type of the document, i.e task or user. (String)", 
+  "userId": "The id of the user (String)",
+  "taskId": "The id of the task, will be applicable only for task. (String)",
+  "completed": "The work accomplished after the previous progress update. (String)",
+  "planned": "The planned work to be accomplished before the next update. (String)",
+  "blockers": "Issues or obstacles that are preventing progress .(String)",
+  "date": "The date for which the progress document pertains to. (Unix Timestamp)",
+  "createdAt": "The timestamp indicating the creation time of the progress document. (Unix Timestamp)" 
+}
+
+```
+
+## Example
+User Progress Document
+```json
+{
+  "id": "d4606ee112f7892c45a0",
+  "type": "user",
+  "userId": "f042d216571a40ece689",
+  "completed": "Implemented authentication feature",
+  "planned": "Refactor code for better performance",
+  "blockers": "Waiting for approval from the team",
+  "date": 1683676800000,
+  "createdAt": 1683681079838
+}
+```
+
+Task progress Document
+```json
+{
+  "id": "e71c150bebb80e5e1c15",
+  "type": "task",
+  "taskId": "4ERr8WrizICemnQnMF0U",
+  "userId": "bb1e01bcee87e555011c",
+  "completed": "Reviewed code and provided feedback to teammates",
+  "planned": "Attend project meeting and work on UI enhancements",
+  "blockers": "Awaiting clarification on design requirements",
+  "date": 1683676800000,
+  "createdAt": 1683681079838
+}
+```
diff --git a/users/README.md b/users/README.md
@@ -1,7 +1,52 @@
 # Users
 
+```json
+{
+	"id": "string",
+	"username": "string",
+	"first_name": "string",
+	"last_name": "string",
+	"email": "string",
+	"phone": "number",
+	"yoe": "number",
+	"company": "string",
+	"designation": "string",
+	"img": "string",
+	"github_id": "string",
+	"github_display_name": "string",
+	"linkedin_id": "string",
+	"twitter_id": "string",
+	"instagram_id": "string",
+	"skills": [],
+	"joined_discord": "string",
+	"website": "string",
+	"isMember": "boolean",
+	"userType": "string",
+	"tokens": {
+		"githubAccessToken": "string"
+	},
+	"status": "string",
+	"roles": {
+		"app_owner": "boolean",
+		"archived": "boolean",
+		"member": "boolean",
+		"restricted": "boolean",
+		"super_user": "boolean",
+		"in_discord": "boolean"
+	},
+	"profileURL": "string",
+	"picture": {
+		"publicId": "string",
+		"url": "string"
+	}
+}
 ```
+
+### Example
+
+```json
 {
+
   'id': string,
   'username': string,
   'first_name': string,
@@ -24,5 +69,44 @@
   'userType': string,
   'tokens': {},
   'status': string
+
+  "id": "12345",
+  "username": "ankur",
+  "first_name": "Ankur",
+  "last_name": "Narkhede",
+  "email": "abc@gmail.com",
+  "phone": 1234567890,
+  "yoe": 0,
+  "company": "BigCo",
+  "designation": "Software Engineer",
+  "img": "./img.png",
+  "github_id": "ankur",
+  "github_display_name": "Ankur Narkhede",
+  "linkedin_id": "ankurnarkhede",
+  "twitter_id": "whatifiz",
+  "instagram_id": "myIgId",
+  "skills": [],
+  "joined_discord": "2023-01-13T18:21:09.278000+00:00",
+  "website": "mywebsite.com",
+  "isMember": true,
+  "userType": "",
+  "tokens": {
+     "githubAccessToken": "ankurGithubAccessToken",
+  },
+  "status": "active",
+  "roles": {
+    "app_owner": false,
+    "archived": false,
+    "member" : true,
+    "restricted": false,
+    "super_user": false,
+    "in_discord" : true,
+  },
+  "profileURL": "https://abcde.com",
+  "picture":{
+    "publicId": "profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar",
+    "url": "https://res.cloudinary.com/realdevsquad/image/upload/v1663885133/profile/mtS4DpUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar.jpg",
+  }
+
 }
-```
+```