cns-course-mfe 0.0.1

package/README.md

@@ -0,0 +1,71 @@
+# cns-courses-mfe
+Home Learning Course Management Page
+
+Built with Yarn, React, TypeScript, MUI, Vite, and Storybook.
+
+## Initial Installation
+
+### Prerequisites
+
+Before installing this project, ensure you have the following installed on your system:
+
+- Node.js
+- yarn package manager
+- Git
+
+### Installation Steps
+
+1. **Clone the repository**
+    ```bash
+    git clone <repository-url>
+    cd <project-directory>
+    ```
+
+2. **Install dependencies**
+    ```bash
+    yarn install
+    ```
+
+3. **Start the development server**
+    ```bash
+    yarn start
+    ```
+    
+4. **Verify Storybook is running**
+    
+    The Storybook documentation should now be running at `http://localhost:6006`
+
+## Scripts Documentation
+
+### Development Scripts
+- **`start` / `storybook`** - Starts the Storybook development server on port 6006.
+
+### Code Quality Scripts
+- **`lint`** - Runs ESLint to check for code quality issues and style violations.
+- **`lint:fix`** - Runs ESLint with automatic fixing enabled to resolve fixable issues.
+- **`format`** - Formats all source files in the `./src` directory using Prettier.
+- **`format:check`** - Checks if source files in `./src` are formatted according to Prettier rules without modifying them.
+
+### Testing Scripts
+- **`test:run`** - Runs all tests once with Vitest
+- **`test:coverage`** - Runs all tests once with Vitest and generates a coverage report.
+- **`test:watch`** - Runs Vitest in watch mode for continuous testing during development.
+- **`test:ui`** - Launches Vitest with a UI interface for interactive test management.
+
+### Build Scripts
+- **`build:dist`** - Builds the component library distribution files using Vite.
+- **`build:storybook`** - Builds the static Storybook documentation site.
+
+## Copy Scripts
+
+- **`copy:package`** - Copies the `package.json` file from the project root to the `dist` directory.
+- **`copy:readme`** - Copies the `README.md` file from the project root to the `dist` directory.
+- **`copy`** - Copies all the metadata files needed for distribution into the `dist` directory.
+
+### CI/CD Scripts
+- **`test`** - Runs linting and test coverage checks for continuous integration.
+- **`build`** - Runs both distribution and Storybook builds for continuous integration.
+- **`ci`** - Executes the complete CI pipeline: tests followed by builds.
+
+## Pre-commit Script
+Husky is configured to run a script before all commits that runs Prettier on modified code.

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "cns-course-mfe",
+  "version": "0.0.1",
+  "description": "Home Learning Course Management Page",
+  "repository": "https://github.com/edgenuity/cns-course-mfe.git",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "start": "yarn storybook",
+    "storybook": "storybook dev -p 6006",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "format": "prettier --write ./src",
+    "format:check": "prettier --check ./src",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "build:dist": "vite build",
+    "build:storybook": "storybook build",
+    "copy:package": "cp ./package.json ./dist/package.json",
+    "copy:readme": "cp ./README.md ./dist/README.md",
+    "copy": "yarn copy:package && yarn copy:readme",
+    "test": "yarn lint && yarn test:run",
+    "build": "yarn build:dist && yarn build:storybook && yarn copy",
+    "ci": "yarn build && yarn test --coverage"
+  },
+  "prettier": "@imaginelearning/prettier-config",
+  "dependencies": {
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "peerDependencies": {
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "devDependencies": {
+    "@imaginelearning/prettier-config": "^0.1.1",
+    "@storybook/addon-a11y": "^10.1.11",
+    "@storybook/addon-docs": "^10.1.11",
+    "@storybook/addon-vitest": "^10.1.11",
+    "@storybook/react-vite": "^10.1.11",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/node": "^25.0.9",
+    "@types/react": "^19.2.8",
+    "@types/react-dom": "^19.2.3",
+    "@typescript-eslint/eslint-plugin": "^8.53.1",
+    "@typescript-eslint/parser": "^8.53.1",
+    "@vitejs/plugin-react": "^5.1.2",
+    "@vitejs/plugin-react-swc": "^4.2.2",
+    "@vitest/coverage-v8": "^4.0.17",
+    "@vitest/ui": "^4.0.17",
+    "actions": "^1.3.0",
+    "eslint": "^9.39.2",
+    "eslint-config-react-app": "^7.0.1",
+    "eslint-plugin-jest-dom": "^5.5.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-storybook": "^10.1.11",
+    "eslint-plugin-testing-library": "^7.15.4",
+    "globals": "^17.0.0",
+    "husky": "^9.1.7",
+    "jsdom": "^27.4.0",
+    "playwright": "^1.57.0",
+    "prettier": "^3.8.0",
+    "storybook": "^10.1.11",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.17"
+  }
+}