Skip to content

Commit da1f011

Browse files
committed
feat: Add extensive documentation for Evalify, update Docusaurus configuration, and remove unused static assets.
1 parent 96a6ff0 commit da1f011

66 files changed

Lines changed: 12304 additions & 670 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
name: Build Job
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 0
28+
29+
- name: Install Node.js
30+
uses: actions/setup-node@v4
31+
with:
32+
node-version: 20
33+
cache: 'pnpm'
34+
35+
- name: Install pnpm
36+
uses: pnpm/action-setup@v4
37+
with:
38+
version: 9
39+
40+
- name: Install dependencies
41+
run: pnpm install --frozen-lockfile
42+
43+
- name: Build website
44+
run: pnpm run build
45+
46+
- name: Upload Build Artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: build
50+
51+
deploy:
52+
name: Deploy Job
53+
needs: build
54+
runs-on: ubuntu-latest
55+
environment:
56+
name: github-pages
57+
url: ${{ steps.deployment.outputs.page_url }}
58+
steps:
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ Evalify is a comprehensive student evaluation platform designed to streamline an
99
## Installation
1010

1111
```bash
12-
yarn
12+
pnpm
1313
```
1414

1515
## Local Development
1616

1717
```bash
18-
yarn start
18+
pnpm start
1919
```
2020

2121
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2222

2323
## Build
2424

2525
```bash
26-
yarn build
26+
pnpm build
2727
```
2828

2929
This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -33,13 +33,13 @@ This command generates static content into the `build` directory and can be serv
3333
Using SSH:
3434

3535
```bash
36-
USE_SSH=true yarn deploy
36+
USE_SSH=true pnpm deploy
3737
```
3838

3939
Not using SSH:
4040

4141
```bash
42-
GIT_USER=<Your GitHub username> yarn deploy
42+
GIT_USER=<Your GitHub username> pnpm deploy
4343
```
4444

4545
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
@@ -77,7 +77,7 @@ To contribute to this documentation:
7777
1. Fork the repository
7878
2. Create a feature branch
7979
3. Make your changes
80-
4. Test locally using `yarn start`
80+
4. Test locally using `pnpm start`
8181
5. Submit a pull request
8282

8383
## License
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Batch Creation
3+
sidebar_label: Batch Creation
4+
sidebar_position: 3
5+
---
6+
7+
# Batch Creation
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Course Creation
3+
sidebar_label: Course Creation
4+
sidebar_position: 5
5+
---
6+
7+
# Course Creation
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Department Creation
3+
sidebar_label: Department Creation
4+
sidebar_position: 2
5+
---
6+
7+
# Department Creation

docs/admin/config/lab-creation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Lab Creation
3+
sidebar_label: Lab Creation
4+
sidebar_position: 6
5+
---
6+
7+
# Lab Creation
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Semester Creation
3+
sidebar_label: Semester Creation
4+
sidebar_position: 4
5+
---
6+
7+
# Semester Creation

docs/admin/config/user-creation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: User Creation
3+
sidebar_label: User Creation
4+
sidebar_position: 1
5+
---
6+
7+
# User Creation

docs/admin/logs-and-monitoring.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Logs and Monitoring
3+
sidebar_label: Logs and Monitoring
4+
---
5+
6+
# Logs and Monitoring

docs/admin/overview.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Admin Overview
3+
sidebar_label: Admin Overview
4+
---
5+
6+
# Admin Overview

0 commit comments

Comments
 (0)