From bd080e3d5223a8666262db679a3a969705ecca55 Mon Sep 17 00:00:00 2001 From: Drish-xD Date: Thu, 5 Sep 2024 02:10:39 +0530 Subject: [PATCH] chore: fix docs --- docs/GUIDE.md | 12 ++++++------ docs/INSTALATION.md | 23 ++++++++++++++++++++++- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/docs/GUIDE.md b/docs/GUIDE.md index 6ea4ce1..9875abc 100644 --- a/docs/GUIDE.md +++ b/docs/GUIDE.md @@ -22,22 +22,22 @@ ## Features -1. **Create, Edit, and Duplicate Sessions** +1. **Create, Edit, and Duplicate Sessions:** Easily manage sessions with options to create, edit, and duplicate. -2. **Presets for Ease** +2. **Presets for Ease:** Simplifies form-filling with presets based on selected groups. -3. **Quiz & Live Table Management** +3. **Quiz & Live Table Management:** Uses Tables with filtering, pagination, and expanded modals for more information. -4. **Real-Time Polling** +4. **Real-Time Polling:** Dynamically refreshes table data using polling for real-time updates. -5. **Server-Side Rendering with Server Actions** +5. **Server-Side Rendering with Server Actions:** Delivers fast pages and handles form submissions with SSR and Server Actions in Next.js. -6. **End-to-End (E2E) Testing** +6. **End-to-End (E2E) Testing:** Ensures application reliability and functionality through comprehensive Cypress E2E tests. ## Routes diff --git a/docs/INSTALATION.md b/docs/INSTALATION.md index 5efd1a6..004715a 100644 --- a/docs/INSTALATION.md +++ b/docs/INSTALATION.md @@ -49,8 +49,29 @@ npm run build ``` -1. **Start the Server:** +2. **Start the Server:** ```bash npm run start ``` + +## Other Useful Scripts + +1. **Linting & Formating:** + + ```bash + npm run lint:fix + npm run format + ``` + +2. **Unit Testing:** + + ```bash + npm run test:jest + ``` + +3. **E2E Testing:** + + ```bash + npm run test:cypress + ```