Jest testing setup (#34)

.eslintrc.json

@@ -1,3 +1,6 @@
 {
-  "extends": ["next/core-web-vitals", "next/typescript", "eslint:recommended"]
+  "extends": ["next/core-web-vitals", "next/typescript", "eslint:recommended"],
+  "env": {
+    "jest": true
+  }
 }

.github/workflows/nextjs-lint-build.yml

@@ -33,3 +33,6 @@ jobs:
 
       - name: TypeScript type check
         run: npm run type-check
+
+      - name: Run Jest tests
+        run: npm run test

README.md

@@ -94,6 +94,23 @@ After the build is complete, you can start the production server with:
 npm run start
 ```
 
+## Running the test cases
+
+To run the test cases, execute following command:
+```bash
+npm run test
+```
+
+To execute the test cases simultaneously as you make changes to the files, execute following command:
+```bash
+npm run test:watch
+```
+
+To get the test coverage of the project, execute following command:
+```bash
+npm run test:coverage
+```
+
 ## Project Structure
 
 The main components of the DiceDB Playground include:

jest.config.ts

@@ -0,0 +1,21 @@
+import type { Config } from 'jest';
+import nextJest from 'next/jest.js';
+
+const createJestConfig = nextJest({
+  // Provide the path to your Next.js app to load next.config.js and .env files in your test environment
+  dir: './',
+});
+
+// Add any custom config to be passed to Jest
+const config: Config = {
+  coverageProvider: 'v8',
+  testEnvironment: 'jsdom',
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+  },
+  // Add more setup options before each test is run
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
+};
+
+// createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async
+export default createJestConfig(config);

jest.setup.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';