Main to staging

.cursor/mcp.json

@@ -1,7 +1,3 @@
 {
-  "mcpServers": {
-    "nx-mcp": {
-      "url": "http://localhost:9355/sse"
-    }
-  }
+  "mcpServers": {}
 }

backend_and_general_guidelines.md

@@ -16,6 +16,8 @@ const SEC_PER_HOUR = 3600;
 const WAIT_DURATION_HRS = 14;
 end_timestamp_sec = start_timestamp_sec + WAIT_DURATION_HRS * SEC_PER_HOUR;
 ```
+## 1.4. Document regex expressions
+Whenever a regular expression is used in the code, add a one-line comment explaining what the regex does, since regex patterns are often difficult to read and maintain.
 
 # 2. Writing APIs
 

frontend_guidelines.md

@@ -20,6 +20,191 @@ Prefer `sx` props over inline styles for better maintainability and theming supp
 + <Box sx={{ bgcolor: "primary.main", p: 2 }}></Box>
 ```
 
+### 1.2 Styling Pattern with sx (Recommended)
+
+To keep components clean, readable, and scalable, follow a **"static styles + local overrides"** pattern.
+
+#### 1.2.1 Centralize Static Styles
+
+Define static styles in a dedicated object **near the bottom of the file**.
+
+```typescript
+const loListStyles = {
+  listItem: {
+    display: 'flex',
+    alignItems: 'center',
+    justifyContent: 'space-between',
+    p: 1.5,
+    mb: 1,
+    borderRadius: 2,
+    '&:hover': {
+      boxShadow: '0 4px 8px rgba(0,0,0,0.2)',
+    }
+  },
+  listHeader: {
+    display: 'flex',
+    justifyContent: 'space-between',
+    gap: 1,
+    mb: 2,
+    flexWrap: 'wrap',
+  }
+};
+```
+✅ Keeps JSX clean  
+✅ Improves readability  
+
+
+#### 1.2.2 Prefer sx Composition Over Style Functions
+
+When a small part of the style **depends on local state**, do not convert the entire style into a function.
+
+❌ Avoid:
+
+```typescript
+listItem: (isActive: boolean) => ({
+  backgroundColor: isActive ? 'green' : 'white',
+});
+```
+
+✅ Prefer sx composition :
+
+```jsx
+<Paper
+  sx={{
+    ...loListStyles.listItem,
+    color: isActive ? 'green' : 'white',
+  }}
+/>
+```
+
+
+#### 1.2.3 Use sx Array for Conditional Overrides
+
+MUI allows sx to be an array. Later entries override earlier ones.
+
+```jsx
+<Box
+  sx={[
+    styles.container,
+    isSelected && { borderColor: 'primary.main' },
+    isDisabled && { opacity: 0.5 },
+  ]}
+/>
+```
+
+This pattern is preferred over:
+
+- multiple ternaries
+- deeply nested conditions
+- inline style objects
+
+#### 1.2.4 Component-Level Style Ownership
+
+Each component should own its styles.
+
+❌ Avoid mixing **unrelated component styles**:
+
+```typescript
+// Two unrelated components in the same file, but all styles in one object
+const styles = {
+  navbar: { display: 'flex', p: 2},
+  navbarItem: { color: 'white', ml: 2 },
+  sidebar: { width: 250, bgcolor: '#f5f5f5', p: 2 },
+  sidebarItem: { mb: 1, cursor: 'pointer' },
+};
+```
+- Hard to tell which styles belong to which component
+- Difficult to maintain as the file grows
+- Risk of accidental overrides
+
+✅ Recommended:
+
+```typescript
+// Component 1: Navbar
+const navbarStyles = {
+  root: { display: 'flex', p: 2 },
+  item: { color: 'white', ml: 2, cursor: 'pointer' },
+};
+
+// Component 2: Sidebar
+const sidebarStyles = {
+  root: { width: 250, bgcolor: '#f5f5f5', p: 2 },
+  item: { mb: 1, cursor: 'pointer' },
+};
+```
+
+Benefits:
+- Better encapsulation
+- Easier refactoring
+- Fewer merge conflicts
+- Clear ownership
+
+#### 1.2.5 Inline sx is fine for very simple, one-off styles
+
+For tiny, one-line, self-contained style adjustments, it’s okay to write sx inline.\
+**Examples:**
+```jsx
+<Box sx={{ p: 1, bgcolor: 'primary.light' }}>Hello</Box>
+
+<Button sx={{ ml: 2 }}>Click me</Button>
+```
+#### Notes:
+
+- Use inline sx only for trivial, non-reusable styles.
+
+- For complex or reusable styles, always define a dedicated style object.
+
+### 1.3 Color Palette Usage
+
+#### 1.3.1 Always Use Theme Palette Tokens
+**Examples:**
+```jsx
+<Box sx={{ color: 'text.primary', bgcolor: 'background.paper' }} />
+```
+#### 1.3.2 Use Gradients Defined in the Theme Palette
+
+- Always use gradients defined under palette.gradients.
+
+- Do not define gradient values directly inside components.
+
+- If a required gradient is not available,**add a new gradient to the theme palette with a clear, semantic key.**
+
+## NOTE: 
+- Ensures light/dark mode compatibility for color being used
+
+### 1.4 Typography
+
+#### 1.4.1 Use Theme Typography Variants Only
+
+#### 1.4.2 Font Sizes Should Come From Theme.
+- Prefer MUI typography variants (T1,h1–h6, body1, body2, etc.) instead of defining custom font sizes.
+
+- If a local override is required for typography-related properties (fontSize, lineHeight, fontWeight, etc.), ensure it is responsive across all breakpoints.
+- Always verify typography on small, medium, and large screens. ❌ Avoid **single-screen overrides**
+
+#### 1.5 Use Shadows From the Central shadows.ts Array
+- Always use shadow values defined in shadows.ts.
+- Do not define custom boxShadow values inside components.
+- If the required shadow intensity or opacity is not available, add a new entry to the shadows.ts array instead of creating ad-hoc shadows.
+
+❌ Avoid:
+```tsx
+sx={{ boxShadow: '0 4px 8px rgba(0,0,0,0.2)' }}
+```
+✅ Prefer:
+```tsx
+sx={{ boxShadow: theme.shadows[2] }}
+```
+
+
+#### 1.6 Override Common Components in components.ts
+- Commonly used components across the project must have their some of the styles overridden centrally.
+
+## NOTE:
+- Overrides for Button, TextField, and other frequently used components are already defined.
+e.g button, textfield and others are already done.
+
+
 ## 2. State Management
 
 ### 2.1 Derived State Optimization

getting_started.md

@@ -26,13 +26,38 @@ Ensure you have the following installed on your system before proceeding:
 
 ## Database Setup
 
-1. **Check for SQL Setup Files**
-   - Navigate to the project folder and locate the `comments_database_setup` directory.
-   - Inside, you will find SQL scripts for setting up the database.
+The project uses **Prisma** for database migrations. Ensure MySQL is running and the database exists before running migrations.
 
-2. **Run SQL Scripts**
-   - Open MySQL Workbench.
-   - Execute the SQL queries from the `comments_database_setup` folder to create the necessary database and tables.
+1. **Create the database** (if it does not exist)
+   - Open MySQL Workbench or use the MySQL CLI.
+   - Create the database: `CREATE DATABASE comments_test;` (or your chosen database name).
+
+2. **Configure environment variables**
+   - Create `packages/alea-frontend/.env.local` with the following database connection variables (update as required):
+
+   ```
+   MYSQL_HOST=127.0.0.1
+   MYSQL_PORT=3306
+   MYSQL_USER=root
+   MYSQL_PASSWORD=password
+   MYSQL_COMMENTS_DATABASE=comments_test
+   ```
+
+3. **Run Prisma migrations**
+   - Deploy migrations to create/update tables:
+     ```sh
+     npm run prisma:migrate-deploy
+     ```
+   - For development with migration creation, use:
+     ```sh
+     npm run prisma:migrate-dev
+     ```
+
+4. **Generate Prisma client**
+   - The client is generated automatically by the prebuild step. To generate manually:
+     ```sh
+     npm run prisma:generate
+     ```
 
 ## Running the Applications  
 
@@ -55,19 +80,32 @@ This guide provides step-by-step instructions to create and configure an Access
 
 Execute the SQL queries from the `intialSqlSetup.sql` file to set up the sys-admin ACL, initial course metadata, and other required data.
 
-### Step 2: Insert into `ResourceAccess`
-
-Run the following SQL query to add resource access control:
 
-   ```INSERT INTO ResourceAccess (resourceId, actionId, aclId) VALUES ('/**', 'ACCESS_CONTROL', 'sys-admin');```
-
-### Step 3: Assign Resource-Action Permissions
+### Step 2: Assign Resource-Action Permissions
 
 1. Navigate to the **exp** page in the application.
 2. Locate and click on the **system-administrator** button.
 3. Follow the prompts to create a resource-action assignment by specifying the desired resources and actions that the `sys-admin` role should control.
 4. Save the changes.
 
+### Step 3: University Admin Setup
+
+Set up the university admin to access the university and create semesters:
+
+1. **Create the university admin ACL** on the ACL page (`/acl`): Click "Create new ACL" and create the ACL (e.g., `fau-admin` for FAU). Set the updater ACL to `sys-admin` and add the desired user(s) as members.
+2. **Assign resource-action**: Navigate to the **exp** page and click the **system-administrator** button to open the sys-admin panel. Assign the resource-action: resource `/university/{universityId}/university-sem-info` with action `MUTATE` to the `{universityId}-admin` ACL (replace `{universityId}` with your university ID, e.g., `FAU`).
+3. The university admin can then navigate to `/u/{universityId}/university-admin` to access the dashboard and create semesters.
+
+### Step 4: Create Semester and Add Course to Semester
+
+Prerequisites: Complete Step 3 to set up the `{universityId}-admin` ACL and resource-action. Admins should see the "go to university admin page" link at `/u/{universityId}`.
+
+1. **Select semester**: Go to the University Admin page (`/u/{universityId}/university-admin`) and select the semester to which you want to add a course. Create a new semester if needed.
+2. **Add course**: In the Course Management section, select a course from the dropdown menu or manually enter the Course ID. Click the **Add Course to Semester** button.
+3. **Create Instructor ACL**: After adding the course, click the **Create Instructor ACL** button next to the Course ID. The ACL is created immediately—you can navigate directly to the ACL page (`/acl/{courseId}-{instanceId}-instructors`) to edit it and add instructor members. Then request the Sys-Admin to approve the course.
+4. **Sys-Admin approval**: The Sys-Admin approves the course by performing a **Quick Course Access Setup** from the sys-admin panel. After approval, instructors added to that course's ACL can access the Instructor Dashboard.
+5. **Instructor setup**: The instructor can now access the **Access Control** tab in the Instructor Dashboard. Click the **Default Resource-Action Setup** button to create the resource-action assignments for the course. Once complete, all tabs in the Instructor Dashboard become available.
+
 ## Fake User Login
 
 1. *Login Flow*  
@@ -92,6 +130,57 @@ VALUES (
   1
 );
 ```
+- Run the following SQL query to add corresponding resource access control:
+(**NOTE**: replace semester name in `resourceId` with the current `semesterId` **or** prefer **UI** instead of using this sql query to add resourceAccess control)
+
+   ```sql
+   INSERT INTO ResourceAccess (resourceId, actionId, aclId) 
+   VALUES ('/instance/WS25-26/job-portal', 'APPLY', 'job-portal-students');
+   ```
+
+## Job Portal ACL for ADMINS
+
+- A closed ACL `job-portal-admins` for admins of Job Portal.
+- System Administrator will decide whom to make admin.
+
+#### Database Entry
+
+```sql
+INSERT INTO AccessControlList (id, description, updaterACLId, isOpen)
+VALUES (
+  'job-portal-admins',
+  'Admins of job portal',
+  'sys-admin',
+  0
+);
+```
+
+- Run the following SQL query to add corresponding resource access control:(**NOTE**: replace semester name in `resourceId` with the current `semesterId` **or** prefer **UI** instead of using this sql query to add resourceAccess control)
+
+   ```sql
+   INSERT INTO ResourceAccess (resourceId, actionId, aclId) 
+   VALUES ('/instance/WS25-26/job-portal', 'MANAGE_JOB_TYPES', 'job-portal-admins');
+   ```
+
+- After ACL is being created ,add members into `job-portal-admins` **manually using UI**.
+
+## Job Portal ACL for ADMINS
+
+- A closed ACL `job-portal-admins` for admins of Job Portal.
+- System Administrator will decide whom to make admin.
+
+#### Database Entry
+
+```sql
+INSERT INTO AccessControlList (id, description, updaterACLId, isOpen)
+VALUES (
+  'job-portal-admins',
+  'Admins of job portal',
+  'sys-admin',
+  0
+);
+```
+- After ACL is being created ,add members into `job-portal-admins` manually using UI.
 
 ## env.local
 

intialSqlSetup.sql → initialSqlSetup.sql

@@ -10,6 +10,12 @@ INSERT INTO
 VALUES
     ('sys-admin', NULL, 'fake_joy');
 
+-- Insert into `ResourceAccess`
+INSERT INTO
+    ResourceAccess (resourceId, actionId, aclId)
+VALUES
+    ('/**', 'ACCESS_CONTROL', 'sys-admin');
+
 -- Insert course metadata
 INSERT INTO
     courseMetadata (

job_portal/README.md

@@ -0,0 +1 @@
+# Documentation for Job Portal in ALeA