From b23010c0b23ab54d26ea1e726bc8c3673c4b5bc2 Mon Sep 17 00:00:00 2001 From: Randhir Kumar Singh <97341921+heyrandhir@users.noreply.github.com> Date: Thu, 27 Apr 2023 22:13:51 +0530 Subject: [PATCH 1/7] data model for standup --- standup/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 standup/README.md diff --git a/standup/README.md b/standup/README.md new file mode 100644 index 0000000..f4594a1 --- /dev/null +++ b/standup/README.md @@ -0,0 +1,12 @@ +# Firestore Standup collection data model + +``` +{ + "userId": "String", + "date": "timestamp", + "yesterday": "String", + "today": "String", + "blockers": "String", + "createdAt": "timestamp", +} +``` \ No newline at end of file From 6db7b210bd04eddd8d6ea12cef1d0beb2c3602b9 Mon Sep 17 00:00:00 2001 From: Randhir Kumar Singh <97341921+heyrandhir@users.noreply.github.com> Date: Sat, 29 Apr 2023 07:00:52 +0530 Subject: [PATCH 2/7] updated the data model for progress api --- standup/README.md | 44 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/standup/README.md b/standup/README.md index f4594a1..8a3f97c 100644 --- a/standup/README.md +++ b/standup/README.md @@ -1,12 +1,44 @@ # Firestore Standup collection data model +```json +{ + "id": "String", // Unique identifier for the document + "type": "String", // Type of the document, e.g., "task progress" or "user progress" + "userId": "String", // User ID (applicable for both task progress and user progress) + "taskId": "String", // Task ID (applicable for task only) + "completed": "String", // Completed portion of the task (applicable for both similar to yesterday or past progress for user) + "planned": "String", // Planned portion of the task (applicable for both similar to today or upcoming plan for user) + "blockers": "String", // Blockers (applicable for both task and user progress) + "date": "Timestamp", // Date of the standup or user progress (applicable for user progress) + "createdAt": "Timestamp" // Creation timestamp (applicable for both) +} + +``` + +## Example +User Progress Update +```json +{ + "id": "d4606ee112f7892c45a0", + "type": "task", + "userId": "f042d216571a40ece689", + "taskId": "a52c1d09780ee641f462", + "completed": "Implemented authentication feature", + "planned": "Refactor code for better performance", + "blockers": "Waiting for approval from the team", + "date": 1651224000, + "createdAt": 1651228230 +} ``` +Task progress update +```json { - "userId": "String", - "date": "timestamp", - "yesterday": "String", - "today": "String", - "blockers": "String", - "createdAt": "timestamp", + "id": "e71c150bebb80e5e1c15", + "type": "user", + "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", + "createdAt": 1651224000 } ``` \ No newline at end of file From 221a845ae31b598387180c0b52caeda4e35c351e Mon Sep 17 00:00:00 2001 From: Randhir Kumar Singh <97341921+heyrandhir@users.noreply.github.com> Date: Mon, 1 May 2023 08:15:06 +0530 Subject: [PATCH 3/7] change the folder name to progress from standup --- {standup => progress}/README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {standup => progress}/README.md (100%) diff --git a/standup/README.md b/progress/README.md similarity index 100% rename from standup/README.md rename to progress/README.md From 3689983e80a9e214aa7efaca71e62f35b6d4a36a Mon Sep 17 00:00:00 2001 From: Randhir Kumar Singh <97341921+heyrandhir@users.noreply.github.com> Date: Wed, 10 May 2023 08:26:12 +0530 Subject: [PATCH 4/7] fixed syntax error in the markdown --- progress/README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/progress/README.md b/progress/README.md index 8a3f97c..d50138e 100644 --- a/progress/README.md +++ b/progress/README.md @@ -2,15 +2,15 @@ ```json { - "id": "String", // Unique identifier for the document - "type": "String", // Type of the document, e.g., "task progress" or "user progress" - "userId": "String", // User ID (applicable for both task progress and user progress) - "taskId": "String", // Task ID (applicable for task only) - "completed": "String", // Completed portion of the task (applicable for both similar to yesterday or past progress for user) - "planned": "String", // Planned portion of the task (applicable for both similar to today or upcoming plan for user) - "blockers": "String", // Blockers (applicable for both task and user progress) - "date": "Timestamp", // Date of the standup or user progress (applicable for user progress) - "createdAt": "Timestamp" // Creation timestamp (applicable for both) + "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)" } ``` @@ -20,25 +20,26 @@ User Progress Update ```json { "id": "d4606ee112f7892c45a0", - "type": "task", + "type": "user", "userId": "f042d216571a40ece689", - "taskId": "a52c1d09780ee641f462", "completed": "Implemented authentication feature", "planned": "Refactor code for better performance", "blockers": "Waiting for approval from the team", - "date": 1651224000, - "createdAt": 1651228230 + "date": 1683676800000, + "createdAt": 1683681079838 } ``` Task progress update ```json { "id": "e71c150bebb80e5e1c15", - "type": "user", + "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", - "createdAt": 1651224000 + "date": 1683676800000, + "createdAt": 1683681079838 } ``` \ No newline at end of file From 89ec766b61b8bc116c825e98e6eab6b49a355b32 Mon Sep 17 00:00:00 2001 From: Randhir Kumar Singh <97341921+heyrandhir@users.noreply.github.com> Date: Wed, 10 May 2023 08:29:39 +0530 Subject: [PATCH 5/7] rewords the document description --- progress/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/progress/README.md b/progress/README.md index d50138e..840594a 100644 --- a/progress/README.md +++ b/progress/README.md @@ -16,7 +16,7 @@ ``` ## Example -User Progress Update +User Progress Document ```json { "id": "d4606ee112f7892c45a0", @@ -29,7 +29,8 @@ User Progress Update "createdAt": 1683681079838 } ``` -Task progress update + +Task progress Document ```json { "id": "e71c150bebb80e5e1c15", From 48235c51af52b72978dcab6a05533018fd7204ec Mon Sep 17 00:00:00 2001 From: Randhir Kumar Singh <97341921+heyrandhir@users.noreply.github.com> Date: Thu, 11 May 2023 22:12:16 +0530 Subject: [PATCH 6/7] resolve nit comment by Shubham on the PR --- progress/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/progress/README.md b/progress/README.md index 840594a..7570040 100644 --- a/progress/README.md +++ b/progress/README.md @@ -5,7 +5,7 @@ "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)", + "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)", From 6aca4774f440ad22693d341d89af8f8fc71e71a5 Mon Sep 17 00:00:00 2001 From: Nashit Shayan Date: Fri, 12 May 2023 08:18:23 +0530 Subject: [PATCH 7/7] add 'roles: in_discord' and joined_discord field to user model (#32) * add 'roles' to user model * updated user model * Update users/README.md Co-authored-by: Shubham Yadav <46373689+shubham-y@users.noreply.github.com> * add json block * json format fix * Update README.md * Update README.md * add: joined_discord field --------- Co-authored-by: Shubham Yadav <46373689+shubham-y@users.noreply.github.com> Co-authored-by: Ritik Jaiswal <57758447+RitikJaiswal75@users.noreply.github.com> Co-authored-by: Bhavika Tibrewal --- users/README.md | 104 ++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 82 insertions(+), 22 deletions(-) diff --git a/users/README.md b/users/README.md index 4abdbc7..950d94a 100644 --- a/users/README.md +++ b/users/README.md @@ -1,27 +1,87 @@ # 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, - 'last_name': string, - 'email': string, - 'phone': number, - 'yoe': number, - 'company': string, - 'designation': string, - 'img': string, - 'github_id': string, - 'linkedin_id': string, - 'twitter_id': string, - 'instagram_id': string, - 'skills': [], - 'website': string, - 'github_display_name': string, - 'isMember': boolean, - '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", + } } -``` \ No newline at end of file +```