Get all posts sorted by most recent post

.github/workflows/ci.yml

@@ -1,17 +1,13 @@
 name: CI
 on: [push, pull_request]
-env:
-  DATABASE_URL: ${{ secrets.DATABASE_URL }}
-  JWT_TOKEN: ${{ secrets.JWT_TOKEN }}
-  JWT_EXPIRY: ${{ secrets.JWT_EXPIRY }}
 jobs:
-  test:
+  check:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'
       - run: npm ci
-      - run: npx eslint src
-      - run: npx prisma migrate reset --force --skip-seed
+      - run: npm run lint
+      - run: npm run tsc

.husky/pre-commit

@@ -1,4 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npx eslint src
+npm run lint
+npm run tsc

README.md

@@ -2,6 +2,14 @@
 
 ## Setting up
 
+### Quick guide
+
+1. Setup .env
+2. run `npm ci`
+3. run `npx prisma migrate reset` if the schema has changed
+4. run `npx prisma generate` to create required types
+5. run `npm run dev`
+
 ### Pre-requisite
 
 [Follow this guide to create your databases](./DB_SETUP.md)
@@ -18,7 +26,7 @@ Once you have complete the above guide, continue to the steps below.
 
 ## API Spec
 
-[todo]: <Deploy and update the link below>
+[todo]: # Deploy and update the link below
 
 [Deployed API Spec](https://UPDATEME)
 
@@ -40,6 +48,4 @@ The users that are seeded can be used to test the API endpoints and to log into
 
 ## DATABASE ERD
 
-[todo]: <Update this with your ERD>
-
 TODO

docs/openapi.yml

@@ -216,6 +216,131 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /posts/sorted:
+    get:
+      summary: returns a list of sorted post by recent date
+      tags:
+        - post
+      security:
+        - bearerAuth: []
+      responses:
+        "200":
+          description: returns a list of sorted posts by recent date
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Post"
+        "401":
+          description: fail
+  /posts/{id}:
+    put:
+      tags:
+        - post
+      summary: Update a post
+      description: This allows an authenticated user to update their post.
+      operationId: updatePost
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+      requestBody:
+        description: Post content update
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                content:
+                  type: string
+      responses:
+        200:
+          description: Successfully updated post
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Post'
+        400:
+          description: Bad request (invalid input)
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        401:
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        404:
+          description: Post not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
+    delete:
+      tags:
+        - post
+      summary: Delete a post
+      description: This allows an authenticated user to delete their post.
+      operationId: deletePost
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        200:
+          description: Successfully deleted post
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+        401:
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        404:
+          description: Post not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /posts/mine:
+    get:
+      summary: Get all posts created by the authenticated user sorted by date
+      tags:
+        - post
+      security:
+        - bearerAuth: []
+      responses:
+        "200":
+          description: Returns a list of posts created by the logged-in user sorted by date
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Post"
+        "401":
+          description: Unauthorized
+
+
   /logs:
     post:
       tags:
@@ -256,36 +381,95 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+
   /cohorts:
     post:
       tags:
         - cohort
-      summary: Create a cohort
-      description: This can only be done by the logged in user with role TEACHER.
+      summary: Create a new cohort and assign users
+      description: Creates a new cohort and assigns any users (students or teachers) to it.
       operationId: createCohort
       security:
         - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                userIds:
+                  type: array
+                  items:
+                    type: integer
+                  description: 'Array of user IDs to assign to the cohort'
+                name:
+                  type: string
+                  description: 'Name of the created cohort'
       responses:
         201:
-          description: success
+          description: Cohort created successfully
           content:
             application/json:
               schema:
                 type: object
                 properties:
-                  status:
-                    type: string
-                  data:
-                    properties:
-                      cohort:
-                        $ref: '#/components/schemas/Cohort'
-        400:
-          description: fail
+                  cohort:
+                    type: object
+                    description: 'Created cohort object'
+                  usersAssigned:
+                    type: array
+                    items:
+                      type: integer
+                    description: 'IDs of users assigned to the cohort'
+        500:
+          description: Internal server error
+
+    get:
+      tags:
+        - cohort
+      summary: Get all cohorts with their users
+      description: Retrieves all cohorts, including assigned users (students and teachers).
+      operationId: getAllCohorts
+      security:
+        - bearerAuth: []
+      responses:
+        200:
+          description: List of all cohorts with users
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Error'
-
+                type: object
+                properties:
+                  cohorts:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: integer
+                        name:
+                          type: string
+                        users:
+                          type: array
+                          items:
+                            type: object
+                            properties:
+                              id:
+                                type: integer
+                              email:
+                                type: string
+                              role:
+                                type: string
+                              profile:
+                                type: object
+                                properties:
+                                  firstName:
+                                    type: string
+                                  lastName:
+                                    type: string
+        500:
+          description: Internal server error
 components:
   securitySchemes:
     bearerAuth:
@@ -430,7 +614,6 @@ components:
                         type: string
                       profileImageUrl:
                         type: string
-
     CreatedUser:
       type: object
       properties:

eslint.config.js

@@ -0,0 +1,12 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {files: ["**/*.{js,mjs,cjs,ts}"]},
+  {languageOptions: { globals: globals.browser }},
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];