Merge pull request #38 from KeyValueSoftwareSystems/develop

Release v1.0.0 - Initial release

Author: anitta-keyvalue

.eslintrc

@@ -0,0 +1,35 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "es2020": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:react/recommended",
+    "plugin:react/jsx-runtime",
+    "prettier"
+  ],
+  "ignorePatterns": ["dist", ".eslintrc.json"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": ["./tsconfig.json", "./tsconfig.test.json"],
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["react-refresh", "react", "@typescript-eslint"],
+  "rules": {
+    "react-refresh/only-export-components": [
+      "warn",
+      { "allowConstantExport": true }
+    ],
+    "react/react-in-jsx-scope": "off"
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  }
+} 

.eslintrc.json

@@ -0,0 +1,44 @@
+This template outlines the recommended format for creating pull requests within this project. Please fill out all sections before submitting your PR
+
+## Branch Naming:
+
+- Use a descriptive branch name that reflects the change and follows the format: [type]/[brief-description]
+- Replace [type] with feature, fix, refactor, hotfix, or other relevant categories
+- Keep the description concise and clear
+
+## Commit Guidelines:
+
+- Adhere to the "scope:subject" commit message structure
+- Scope can be feat, fix, docs, test, refactor, build, format, etc.
+- Use imperative tense (e.g., "fix: User unable to login")
+## Pull Request Checklist:
+
+[ ] **Read the contributing guidelines** <br />
+[ ] **Branch is up-to-date with the base branch: main (or other designated branch)**<br />
+[ ] **Changes pass all tests: npm test or yarn test (or equivalent command)**<br />
+[ ] **Documentation has been updated (if applicable)**<br />
+## Description:
+- Start your pull request summary with a clear and informative heading. Use the Markdown syntax `##` for the heading, like `## Your Heading Here`.
+- For the section detailing the changes introduced by this pull request, use the Markdown heading `## Changes`. 
+- Briefly describe the changes introduced in this pull request.Ensure that the changelog has been updated accordingly
+- Explain the motivation and the problem it solves
+- Mention any breaking changes
+- Link to related issues or internal tickets
+## Additional Notes:
+
+- Include any other relevant information, such as limitations, known issues, or future improvements.
+## Screenshots (if applicable):
+
+- Add screenshots or GIFs to help visualize your changes.
+## Testing Instructions:
+
+- Provide step-by-step instructions on how to test your changes 
+## Checklist for Reviewers:
+
+[ ] **Code follows project conventions and style guidelines**<br />
+[ ] **Changes do not introduce new warnings or errors**<br />
+[ ] **Unit tests cover the changes adequately**<br />
+[ ] **Documentation is updated correctly and reflects the changes**<br />
+Additional Information:
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the MIT License.

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,14 +2,14 @@ name: Test Suite
 
 on:
     pull_request:
-      branches: [master]
+      branches: [main, develop]
 
 jobs:
   test-and-build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [18.x]
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -26,10 +26,10 @@ jobs:
         run: npm install
 
       - name: Linting
-        run: npm run eslint
-
-      - name: Run tests
+        run: npm run lint
+        
+      - name: Test cases
         run: npm run test
 
       - name: Build
-        run: npm run build
+        run: npm run build

.github/workflows/test-and-build.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 16.x
+          node-version: 18.x
           scope: '@keyvaluesystems'
 
       - name: Install dependencies
@@ -43,22 +43,19 @@ jobs:
         shell: bash
         run: |
           BRANCH="${GITHUB_REF#refs/heads/}"
-          if [ "$BRANCH" == 'master' ]
+          if [ "$BRANCH" == 'main' ]
             then
               echo "Branch validation Successful"
             else
-              echo "Releases only taken from master branch"
+              echo "Releases only taken from main branch"
               exit 1
           fi
-
       - name: Get Latest version from package.json
         run: |
           # Get the latest version from package.json
           LATEST_VERSION=$(node -p "require('./package.json').version")
-
           # Output the latest version as a workflow env
           echo "latest_version=$LATEST_VERSION" >> $GITHUB_ENV
-
       - name: Get new version
         id: get_next_version
         uses: christian-draeger/[email protected]
@@ -70,14 +67,12 @@ jobs:
         run: |
           OLD_VERSION=${{ env.latest_version }}
           NEW_VERSION=${{ steps.get_next_version.outputs.next-version }}
-
           npm version $NEW_VERSION --no-git-tag-version
           git config user.name github-actions
           git config user.email [email protected]
           git add package.json package-lock.json
           git commit -m "Bump version from $OLD_VERSION to $NEW_VERSION"
-          git push origin HEAD:master
-
+          git push origin HEAD:main
       - name: Build Package
         run: npm run build
 
@@ -90,7 +85,7 @@ jobs:
           # Revert package.json and package-lock.json to the previous version
           npm version ${{ env.latest_version }} --no-git-tag-version
           git commit -am "Revert to version ${{ env.latest_version }}"
-          git push origin HEAD:master
+          git push origin HEAD:main
         if: failure()
 
       - name: Create GitHub release

.github/workflows/update-and-publish.yml

@@ -1,52 +1,26 @@
-# These are some examples of commonly ignored file patterns.
-# You should customize this list as applicable to your project.
-# Learn more about .gitignore:
-#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
-
-# Node artifact files
-node_modules/
-dist/
-
-# Compiled Java class files
-*.class
-
-# Compiled Python bytecode
-*.py[cod]
-
-# Log files
+# Logs
+logs
 *.log
-
-# Package files
-*.jar
-
-# Maven
-target/
-dist/
-
-# JetBrains IDE
-.idea/
-
-# Unit test reports
-TEST*.xml
-
-# Generated by MacOS
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
 .DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
 
-# Generated by Windows
-Thumbs.db
-
-# Applications
-*.app
-*.exe
-*.war
-
-# Large media files
-*.mp4
-*.tiff
-*.avi
-*.flv
-*.mov
-*.wmv
-
-/node_modules
-/build
+coverage

.gitignore

@@ -0,0 +1 @@
+npm run lint