@qoretechnologies/reqraft 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/.eslintrc.js +40 -0
  2. package/.github/ISSUE_TEMPLATE/bug_report.md +38 -0
  3. package/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  4. package/.github/ISSUE_TEMPLATE/new-component.md +20 -0
  5. package/.github/ISSUE_TEMPLATE/visual-bug-report.md +38 -0
  6. package/.github/workflows/beta_release.yml +108 -0
  7. package/.github/workflows/tests.yml +120 -0
  8. package/.prettierrc +7 -0
  9. package/CODE_OF_CONDUCT.md +105 -0
  10. package/CONTRIBUTING.MD +78 -0
  11. package/LICENSE +21 -0
  12. package/README.md +43 -0
  13. package/SECURITY.md +3 -0
  14. package/__tests__/setup.js +8 -0
  15. package/build-storybook.log +28 -0
  16. package/dist/components/form/string/String.d.ts +15 -0
  17. package/dist/components/form/string/String.d.ts.map +1 -0
  18. package/dist/components/form/string/String.js +52 -0
  19. package/dist/components/form/string/String.js.map +1 -0
  20. package/dist/components/form/string/String.stories.d.ts +10 -0
  21. package/dist/components/form/string/String.stories.d.ts.map +1 -0
  22. package/dist/components/form/string/String.stories.js +21 -0
  23. package/dist/components/form/string/String.stories.js.map +1 -0
  24. package/dist/index.d.ts +2 -0
  25. package/dist/index.d.ts.map +1 -0
  26. package/dist/index.js +6 -0
  27. package/dist/index.js.map +1 -0
  28. package/dist/types.d.ts +7 -0
  29. package/dist/types.d.ts.map +1 -0
  30. package/dist/types.js +3 -0
  31. package/dist/types.js.map +1 -0
  32. package/package.json +116 -0
  33. package/public/logo-dark.png +0 -0
  34. package/public/logo.png +0 -0
  35. package/public/q-symbol-small.png +0 -0
  36. package/public/q-symbol.png +0 -0
  37. package/public/qoreLogo-dark.png +0 -0
  38. package/public/qoreLogo.png +0 -0
  39. package/src/components/form/string/String.stories.tsx +23 -0
  40. package/src/components/form/string/String.tsx +67 -0
  41. package/src/icons.json +2295 -0
  42. package/src/index.tsx +1 -0
  43. package/src/types.ts +12 -0
  44. package/tests.json +1 -0
  45. package/tsconfig.prod.json +26 -0
package/.eslintrc.js ADDED
@@ -0,0 +1,40 @@
1
+ module.exports = {
2
+ env: {
3
+ browser: true,
4
+ es2021: true,
5
+ },
6
+ extends: [
7
+ 'eslint:recommended',
8
+ 'plugin:@typescript-eslint/recommended',
9
+ 'plugin:react/recommended',
10
+ 'plugin:react/jsx-runtime',
11
+ ],
12
+ overrides: [
13
+ {
14
+ env: {
15
+ node: true,
16
+ },
17
+ files: ['.eslintrc.{js,cjs}'],
18
+ parserOptions: {
19
+ sourceType: 'script',
20
+ },
21
+ },
22
+ ],
23
+ parser: '@typescript-eslint/parser',
24
+ parserOptions: {
25
+ ecmaVersion: 'latest',
26
+ sourceType: 'module',
27
+ },
28
+ plugins: ['@typescript-eslint', 'react'],
29
+ rules: {
30
+ 'linebreak-style': ['error', 'unix'],
31
+ semi: ['error', 'always'],
32
+ '@typescript-eslint/no-explicit-any': 'off',
33
+ 'react/display-name': 'off',
34
+ 'react/prop-types': 'off',
35
+ 'no-extra-boolean-cast': 'off',
36
+ 'no-console': ['error', { allow: ['warn', 'error'] }],
37
+ },
38
+ // Ignore storybook files
39
+ ignorePatterns: ['**/stories/*', '**/mock/*'],
40
+ };
@@ -0,0 +1,38 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: "[BUG] "
5
+ labels: bug
6
+ assignees: Foxhoundn
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ 1. Go to '...'
16
+ 2. Click on '....'
17
+ 3. Scroll down to '....'
18
+ 4. See error
19
+
20
+ **Expected behavior**
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ **Screenshots**
24
+ If applicable, add screenshots to help explain your problem.
25
+
26
+ **Desktop (please complete the following information):**
27
+ - OS: [e.g. iOS]
28
+ - Browser [e.g. chrome, safari]
29
+ - Version [e.g. 22]
30
+
31
+ **Smartphone (please complete the following information):**
32
+ - Device: [e.g. iPhone6]
33
+ - OS: [e.g. iOS8.1]
34
+ - Browser [e.g. stock browser, safari]
35
+ - Version [e.g. 22]
36
+
37
+ **Additional context**
38
+ Add any other context about the problem here.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: "[ENHANCEMENT] "
5
+ labels: enhancement
6
+ assignees: Foxhoundn
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: New component
3
+ about: New component suggestion
4
+ title: "[NEW COMPONENT]"
5
+ labels: enhancement
6
+ assignees: Foxhoundn
7
+
8
+ ---
9
+
10
+ **Component name**
11
+ What should the component be named? Use self-describing name
12
+
13
+ **Component purpose**
14
+ Describe thoroughly the purpose of the suggested / proposed component.
15
+
16
+ **Component reference**
17
+ Is there another library already using this kind of the component?
18
+
19
+ **Screenshot / Draft of the component**
20
+ Add visual representation of the component if there is any
@@ -0,0 +1,38 @@
1
+ ---
2
+ name: Visual bug report
3
+ about: Create a report to help us improve
4
+ title: "[VISUAL BUG]"
5
+ labels: bug
6
+ assignees: Foxhoundn
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ 1. Go to '...'
16
+ 2. Click on '....'
17
+ 3. Scroll down to '....'
18
+ 4. See error
19
+
20
+ **Expected behavior**
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ **Screenshots**
24
+ If applicable, add screenshots to help explain your problem.
25
+
26
+ **Desktop (please complete the following information):**
27
+ - OS: [e.g. iOS]
28
+ - Browser [e.g. chrome, safari]
29
+ - Version [e.g. 22]
30
+
31
+ **Smartphone (please complete the following information):**
32
+ - Device: [e.g. iPhone6]
33
+ - OS: [e.g. iOS8.1]
34
+ - Browser [e.g. stock browser, safari]
35
+ - Version [e.g. 22]
36
+
37
+ **Additional context**
38
+ Add any other context about the problem here.
@@ -0,0 +1,108 @@
1
+ # This is a basic workflow to help you get started with Actions
2
+
3
+ name: Beta release
4
+
5
+ # Controls when the action will run. Triggers the workflow on push or pull request
6
+ # events but only for the develop branch
7
+ on:
8
+ push:
9
+ branches:
10
+ - develop
11
+
12
+ # A workflow run is made up of one or more jobs that can run sequentially or in parallel
13
+ jobs:
14
+ Publish-and-release:
15
+ # The type of runner that the job will run on
16
+ runs-on: ubuntu-latest
17
+
18
+ # Steps represent a sequence of tasks that will be executed as part of the job
19
+ steps:
20
+ - name: Get current time
21
+ uses: josStorer/get-current-time@v2.0.2
22
+ id: current_time
23
+ with:
24
+ format: YYYYMMDD-HH
25
+ utcOffset: '+01:00'
26
+ # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
27
+ # Checkout the repo
28
+ - uses: actions/checkout@v3
29
+ with:
30
+ fetch-depth: 0
31
+ ref: ${{ github.event.pull_request.head.sha }}
32
+
33
+ # Get commit message
34
+ - name: Print head git commit message
35
+ id: get_head_commit_message
36
+ run: echo "::set-output name=HEAD_COMMIT_MESSAGE::$(git show -s --format=%s)"
37
+
38
+ - uses: actions/setup-node@v3
39
+ with:
40
+ node-version: 20.11.0
41
+
42
+ - name: Save release version to outputs
43
+ id: save_release_version
44
+ run: echo ::set-output name=version::$(node -pe "require('./package.json').version")
45
+
46
+ - name: Installing modules
47
+ id: install_modules
48
+ run: |
49
+ yarn cache clean
50
+ rm -rf node_modules
51
+ yarn install
52
+
53
+ - name: Running tests
54
+ id: tests
55
+ run: yarn test:ci
56
+
57
+ - name: Build
58
+ id: build
59
+ run: yarn build
60
+
61
+ - name: Publish to NPM
62
+ id: npm_publish
63
+ uses: JS-DevTools/npm-publish@v1
64
+ with:
65
+ token: ${{ secrets.NPM_TOKEN }}
66
+ tag: beta
67
+ access: public
68
+
69
+ - name: Publish to Chromatic
70
+ id: chromatic_publish
71
+ uses: chromaui/action@v1
72
+ with:
73
+ token: ${{ secrets.GITHUB_TOKEN }}
74
+ projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
75
+
76
+ - name: Create a release
77
+ id: release
78
+ uses: actions/create-release@v1
79
+ env:
80
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
81
+ with:
82
+ tag_name: v${{ steps.save_release_version.outputs.version }}
83
+ release_name: v${{ steps.save_release_version.outputs.version }}
84
+ body: v${{ steps.save_release_version.outputs.version }}
85
+ draft: false
86
+ prerelease: false
87
+
88
+ # Notify discord if success
89
+ - name: Discord notification
90
+ env:
91
+ DISCORD_WEBHOOK: ${{secrets.DISCORD_WEBHOOK}}
92
+ DISCORD_EMBEDS: '[{"author": {"icon_url": "https://avatars.githubusercontent.com/${{ github.actor }}", "name": "${{ github.actor }}", "url": "https://github.com/${{github.actor}}"}, "url": "https://github.com/${{github.repository}}/commit/${{github.sha}}", "fields": [{ "name": "Commit Message", "value": "${{ steps.get_head_commit_message.outputs.HEAD_COMMIT_MESSAGE }}"},{"name": "Repository","value": "[${{github.event.repository.name}}](${{github.event.repository.clone_url}})","inline": true},{"name": "Branch","value": "[${{github.ref_name}}](https://github.com/${{github.repository}}/pull/${{github.ref_name}})","inline": true},{ "name": "Event", "value": "${{github.event_name}}", "inline": true },{"name": "Author","value": "[${{github.actor}}](https://github.com/${{github.actor}})","inline": true},{ "name": "Job", "value": "${{github.job}}", "inline": true },{ "name": "Version", "value": "v${{ steps.save_release_version.outputs.version }}", "inline": true},{"name": "","value": "🤖 [Github Action](https://github.com/${{ github.repository}}/actions/runs/${{ github.run_id}}) 📙 [Documentation](${{ steps.chromatic_publish.outputs.storybookUrl }}) 🎨 [Chromatic Tests](${{ steps.chromatic_publish.outputs.buildUrl }})"}],"color": 65280,"footer": { "text": "Published at ${{steps.current_time.outputs.readableTime}}" }}]'
93
+ DISCORD_AVATAR: 'https://github.com/qoretechnologies/reqore/blob/ae8ce24b7f0984340bf4e6835025d203d1741b3a/public/q-symbol-small.png?raw=true'
94
+ uses: Ilshidur/action-discord@0.3.2
95
+ with:
96
+ args: ':white_check_mark: ReQraft beta v${{ steps.save_release_version.outputs.version }} successfuly released & published.'
97
+ if: success()
98
+
99
+ # Notify discord if failure
100
+ - name: Discord notification
101
+ env:
102
+ DISCORD_WEBHOOK: ${{secrets.DISCORD_WEBHOOK}}
103
+ DISCORD_EMBEDS: '[{"author": {"icon_url": "https://avatars.githubusercontent.com/${{ github.actor }}", "name": "${{ github.actor }}", "url": "https://github.com/${{github.actor}}"}, "url": "https://github.com/${{github.repository}}/commit/${{github.sha}}", "fields": [{ "name": "Commit Message", "value": "${{ steps.get_head_commit_message.outputs.HEAD_COMMIT_MESSAGE }}"},{"name": "Repository","value": "[${{github.event.repository.name}}](${{github.event.repository.clone_url}})","inline": true},{"name": "Branch","value": "[${{github.ref_name}}](https://github.com/${{github.repository}}/pull/${{github.ref_name}})","inline": true},{ "name": "Event", "value": "${{github.event_name}}", "inline": true },{"name": "Author","value": "[${{github.actor}}](https://github.com/${{github.actor}})","inline": true},{ "name": "Job", "value": "${{github.job}}", "inline": true },{ "name": "Version", "value": "v${{ steps.save_release_version.outputs.version }}", "inline": true},{"name": "","value": "🤖 [Github Action](https://github.com/${{ github.repository}}/actions/runs/${{ github.run_id}})"}],"color": 16711680,"footer": { "text": "Triggered at ${{steps.current_time.outputs.readableTime}}" }}]'
104
+ DISCORD_AVATAR: 'https://github.com/qoretechnologies/reqore/blob/ae8ce24b7f0984340bf4e6835025d203d1741b3a/public/q-symbol-small.png?raw=true'
105
+ uses: Ilshidur/action-discord@0.3.2
106
+ with:
107
+ args: ':exclamation: ReQraft beta v${{ steps.save_release_version.outputs.version }} release failed! Click the GitHub Action link below to find out why.'
108
+ if: failure()
@@ -0,0 +1,120 @@
1
+ # This is a basic workflow to help you get started with Actions
2
+
3
+ name: Pull Request Tests
4
+
5
+ # Controls when the action will run. Triggers the workflow on push or pull request
6
+ # events but only for the develop branch
7
+ on:
8
+ pull_request:
9
+ branches:
10
+ - develop
11
+
12
+ # A workflow run is made up of one or more jobs that can run sequentially or in parallel
13
+ jobs:
14
+ PullRequestTests:
15
+ # The type of runner that the job will run on
16
+ runs-on: ubuntu-latest
17
+ env:
18
+ QORUS_TOKEN: ${{ secrets.QORUS_TOKEN }}
19
+ # Steps represent a sequence of tasks that will be executed as part of the job
20
+ steps:
21
+ # Get current time for the commit
22
+ - name: Get current time
23
+ uses: josStorer/get-current-time@v2.0.2
24
+ id: current_time
25
+ with:
26
+ format: YYYYMMDD-HH
27
+ utcOffset: '+01:00'
28
+
29
+ # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
30
+ - name: Get repo
31
+ uses: actions/checkout@v3
32
+ with:
33
+ ref: ${{ github.event.pull_request.head.sha }}
34
+ fetch-depth: 0
35
+
36
+ - name: Print head git commit message
37
+ id: get_head_commit_message
38
+ run: echo "::set-output name=HEAD_COMMIT_MESSAGE::$(git show -s --format=%s)"
39
+
40
+ - uses: actions/setup-node@v3
41
+ with:
42
+ node-version: 20.11.0
43
+
44
+ # Notify Discord to not restart server
45
+ - name: Discord Warning
46
+ env:
47
+ DISCORD_WEBHOOK: ${{secrets.DISCORD_WEBHOOK_DEV}}
48
+ # Mention someone in the embeds
49
+ DISCORD_EMBEDS: '[{ "color":16711680, "description": ":exclamation: Tests started, **please do not restart Qorus on Rippy** for the next 30 minutes." }]'
50
+ DISCORD_AVATAR: 'https://github.com/qoretechnologies/qorus-vscode/blob/95ad81fa8654fe83bb41f68f4de42ae088298e59/public/q-symbol-small.png?raw=true'
51
+ uses: Ilshidur/action-discord@0.3.2
52
+ with:
53
+ args: '<@820316067921395752>'
54
+
55
+ - name: Save release version to outputs
56
+ id: save_release_version
57
+ run: echo ::set-output name=version::$(node -pe "require('./package.json').version")
58
+
59
+ - name: Installing modules
60
+ id: install_modules
61
+ run: |
62
+ yarn install
63
+ yarn install-playwright
64
+ yarn build-storybook --quiet
65
+
66
+ - name: Run build test
67
+ run: |
68
+ yarn build:test:prod
69
+
70
+ - name: Run unit tests
71
+ run: |
72
+ yarn test:ci
73
+
74
+ - name: Serve Storybook and run tests
75
+ run: |
76
+ npx concurrently -k -s first -n "SB,TEST" -c "magenta,blue" \
77
+ "npx http-server storybook-static --port 6008 --silent" \
78
+ "npx wait-on tcp:6008 && yarn test-storybook"
79
+
80
+ - name: Publish to Chromatic
81
+ id: chromatic_publish
82
+ uses: chromaui/action@v1
83
+ with:
84
+ token: ${{ secrets.GITHUB_TOKEN }}
85
+ projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
86
+ exitZeroOnChanges: true
87
+ allowConsoleErrors: true
88
+ debug: true
89
+
90
+ # Notify Discord if Success
91
+ - name: Discord notification success
92
+ env:
93
+ DISCORD_WEBHOOK: ${{secrets.DISCORD_WEBHOOK}}
94
+ DISCORD_EMBEDS: '[{ "author": { "icon_url": "https://avatars.githubusercontent.com/${{ github.actor }}", "name": "${{ github.actor }}", "url": "https://github.com/${{github.actor}}" },"url": "https://github.com/${{github.repository}}/commit/${{github.sha}}","fields": [{ "name": "Commit Message", "value": "${{ steps.get_head_commit_message.outputs.HEAD_COMMIT_MESSAGE }}"},{ "name": "Repository", "value": "[${{github.event.repository.name}}](${{github.event.repository.clone_url}})", "inline": true },{ "name": "Branch", "value": "[${{github.ref_name}}](https://github.com/${{github.repository}}/pull/${{github.ref_name}})", "inline": true },{ "name": "Event", "value": "${{github.event_name}}", "inline": true },{ "name": "Author", "value": "[${{github.actor}}](https://github.com/${{github.actor}})", "inline": true },{ "name": "Job", "value": "${{github.job}}", "inline": true},{ "name": "Version", "value": "v${{ steps.save_release_version.outputs.version }}", "inline": true},{ "name": "", "value": "🤖 [Github Action](https://github.com/${{ github.repository}}/actions/runs/${{ github.run_id}}) 🌐 [View Site]( https://deploy-preview-${{ github.event.pull_request.number}}--magical-starburst-a8bdfc.netlify.app) 📙 [Storybook](${{ steps.chromatic_publish.outputs.storybookUrl }}) 🎨 [Chromatic Tests](${{ steps.chromatic_publish.outputs.buildUrl }})"}],"color":65280,"footer":{"text": "Published at ${{steps.current_time.outputs.readableTime}}"}}]'
95
+ DISCORD_AVATAR: 'https://github.com/qoretechnologies/qorus-vscode/blob/95ad81fa8654fe83bb41f68f4de42ae088298e59/public/q-symbol-small.png?raw=true'
96
+ uses: Ilshidur/action-discord@0.3.2
97
+ with:
98
+ args: ':white_check_mark: Tests run #${{ github.run_number }} for [PR](${{ github.event.pull_request.html_url }}) triggered by ${{ github.triggering_actor }} *succeeded*, click GitHub Action link below to get the VSIX artifact.'
99
+ if: success()
100
+
101
+ # Notify discord if failure
102
+ - name: Discord notification failure
103
+ env:
104
+ DISCORD_WEBHOOK: ${{secrets.DISCORD_WEBHOOK}}
105
+ DISCORD_EMBEDS: '[{ "author": { "icon_url": "https://avatars.githubusercontent.com/${{ github.actor }}", "name": "${{ github.actor }}", "url": "https://github.com/${{github.actor}}" },"url": "https://github.com/${{github.repository}}/commit/${{github.sha}}","fields": [{ "name": "Commit Message", "value": "${{ steps.get_head_commit_message.outputs.HEAD_COMMIT_MESSAGE }}"},{ "name": "Repository", "value": "[${{github.event.repository.name}}](${{github.event.repository.clone_url}})", "inline": true },{ "name": "Branch", "value": "[${{github.ref_name}}](https://github.com/${{github.repository}}/pull/${{github.ref_name}})", "inline": true },{ "name": "Event", "value": "${{github.event_name}}", "inline": true },{ "name": "Author", "value": "[${{github.actor}}](https://github.com/${{github.actor}})", "inline": true },{ "name": "Job", "value": "${{github.job}}", "inline": true },{ "name": "Version", "value": "v${{ steps.save_release_version.outputs.version }}", "inline": true},{ "name": "", "value": "🤖 [Github Action](https://github.com/${{ github.repository}}/actions/runs/${{ github.run_id}})"}],"color":16711680,"footer":{"text": "Published at ${{steps.current_time.outputs.readableTime}}"}}]'
106
+ DISCORD_AVATAR: 'https://github.com/qoretechnologies/qorus-vscode/blob/95ad81fa8654fe83bb41f68f4de42ae088298e59/public/q-symbol-small.png?raw=true'
107
+ uses: Ilshidur/action-discord@0.3.2
108
+ with:
109
+ args: ':exclamation: Tests run #${{ github.run_number }} for [PR](${{ github.event.pull_request.html_url }}) triggered by ${{ github.triggering_actor }} *failed*!'
110
+ if: failure()
111
+
112
+ - name: Discord notification safe to restart
113
+ env:
114
+ DISCORD_WEBHOOK: ${{secrets.DISCORD_WEBHOOK_DEV}}
115
+ DISCORD_EMBEDS: '[{ "color":65280, "description": ":white_check_mark: Tests action finished. It is now safe to restart Qorus on Rippy." }]'
116
+ DISCORD_AVATAR: 'https://github.com/qoretechnologies/qorus-vscode/blob/95ad81fa8654fe83bb41f68f4de42ae088298e59/public/q-symbol-small.png?raw=true'
117
+ uses: Ilshidur/action-discord@0.3.2
118
+ with:
119
+ args: '<@820316067921395752>'
120
+ if: always()
package/.prettierrc ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "trailingComma": "es5",
3
+ "printWidth": 100,
4
+ "semi": true,
5
+ "singleQuote": true,
6
+ "jsxSingleQuote": true
7
+ }
@@ -0,0 +1,105 @@
1
+ <div align="center">
2
+ <br><br><br>
3
+ <img src="./public/qoreLogo.png" alt="Unstated Logo" width="500">
4
+ <br><br><br>
5
+ </div>
6
+
7
+ # Code of Conduct
8
+
9
+ Qore Technologies use [Contributor Covenant v2.0](https://contributor-covenant.org/version/2/0/code_of_conduct) as their code of conduct. The full text is included [below](#contributor-covenant-code-of-conduct-v20) in English, and [translations](https://www.contributor-covenant.org/translations) are available on the Contributor Covenant website.
10
+
11
+ ## Commitment
12
+
13
+ All recipients of reports commit to:
14
+
15
+ - maintain the confidentiality with regard to the reporter and victim of an incident
16
+
17
+ ## Report an issue in a project
18
+
19
+ 1. To report an issue in one of our projects, please follow the security guidelines from that repository.
20
+
21
+ ## More Info
22
+
23
+ For more information, refer to the full
24
+ [Contributor covenant code of conduct page](https://contributor-covenant.org/version/2/0/code_of_conduct).
25
+
26
+ ---
27
+
28
+ ## Contributor Covenant Code of Conduct v2.0
29
+
30
+ ### Our Pledge
31
+
32
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
33
+
34
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
35
+
36
+ ### Our Standards
37
+
38
+ Examples of behavior that contributes to a positive environment for our community include:
39
+
40
+ * Demonstrating empathy and kindness toward other people
41
+ * Being respectful of differing opinions, viewpoints, and experiences
42
+ * Giving and gracefully accepting constructive feedback
43
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
44
+ * Focusing on what is best not just for us as individuals, but for the overall community
45
+
46
+ Examples of unacceptable behavior include:
47
+
48
+ * The use of sexualized language or imagery, and sexual attention or advances of any kind
49
+ * Trolling, insulting or derogatory comments, and personal or political attacks
50
+ * Public or private harassment
51
+ * Publishing others' private information, such as a physical or email address, without their explicit permission
52
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
53
+
54
+ ### Enforcement Responsibilities
55
+
56
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
57
+
58
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
59
+
60
+ ### Scope
61
+
62
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
63
+
64
+ ### Enforcement
65
+
66
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at the email addresses listed above in the [Reporting](#report-an-issue-in-a-project) and [Escalation](#escalate-an-issue) sections. All complaints will be reviewed and investigated promptly and fairly.
67
+
68
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
69
+
70
+ ### Enforcement Guidelines
71
+
72
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ #### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
77
+
78
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
79
+
80
+ #### 2. Warning
81
+
82
+ **Community Impact**: A violation through a single incident or series of actions.
83
+
84
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
85
+
86
+ #### 3. Temporary Ban
87
+
88
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
89
+
90
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
91
+
92
+ #### 4. Permanent Ban
93
+
94
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
95
+
96
+ **Consequence**: A permanent ban from any sort of public interaction within the project community.
97
+
98
+ ### Attribution
99
+
100
+ This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [contributor-covenant.org/version/2/0/code_of_conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct).
101
+
102
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
103
+
104
+ For answers to common questions about this code of conduct, see the FAQ at
105
+ [contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
@@ -0,0 +1,78 @@
1
+ <div align="center">
2
+ <br><br><br>
3
+ <img src="./public/qoreLogo.png" alt="Unstated Logo" width="500">
4
+ <br><br><br>
5
+ </div>
6
+
7
+ # Contributing to Qore Technologies
8
+
9
+ > First off, thanks for taking the time to contribute!
10
+
11
+ Contributions are always welcome. Before contributing please read the
12
+ [code of conduct](CODE_OF_CONDUCT.md) &
13
+ [search the issue tracker](https://github.com/qoretechnologies/qorus-ui/issues) your issue may have already been discussed or fixed in `master`. To contribute,
14
+ [fork](https://help.github.com/articles/fork-a-repo/) QorusToolkit, commit your changes,
15
+ & [send a pull request](https://help.github.com/articles/using-pull-requests/).
16
+
17
+ We put together a set of guidelines for contributing to Qore Technologies and it's packages, which are hosted in the [Qore Technologies Organization](https://github.com/qoretechnologies/reqore) on GitHub. The provided guidelines are not rules but recommendations. Use your best judgement, and feel free to propose changes to this document with a pull request.
18
+
19
+ ## We host our open-source on Github
20
+
21
+ We use github to host our open-source code, to track issues and feature requests, as well as accept pull requests.
22
+
23
+ > We Use [Github Flow](https://guides.github.com/introduction/flow/index.html) for code contributions
24
+
25
+ ## How to contribute
26
+
27
+ Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
28
+
29
+ 1. Fork the repo and create your branch from `develop`.
30
+ 2. If you've added code that should be tested, add tests.
31
+ 3. If you've changed APIs, update the documentation.
32
+ 4. Ensure the test suite passes.
33
+ 5. Make sure your code lints.
34
+ 6. Issue that pull request!
35
+
36
+ ## Any contributions you make will be under the MIT Software License
37
+
38
+ In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
39
+
40
+ ## Report bugs using Github's issues
41
+
42
+ We use GitHub issues to track public bugs. Report a bug by opening a new issue on <code>github.com/qoretechnologies/qorus-ui/issues</code> it's that easy!
43
+
44
+ ## Write bug reports with detail, background, and sample code
45
+
46
+ **Great Bug Reports** tend to have:
47
+
48
+ - A quick summary and/or background of a bug
49
+ - Steps to reproduce
50
+ - Be specific!
51
+ - Give sample code if you can.
52
+ - Expected behavior according to your understanding
53
+ - Current behavior which includes the bug
54
+ - Notes (includes, your reasoning behind the problem or steps you tried to solve the bug)
55
+
56
+ We _love_ thorough bug reports so that we can act fast on them.
57
+
58
+ ## Use a Consistent Coding Style
59
+
60
+ > Reference [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
61
+
62
+ - 2 spaces for indentation rather than tabs
63
+ - 100 character line length
64
+ - Run `npm run lint` to conform to our lint rules
65
+
66
+ ## Community
67
+
68
+ - [GitHub Organization](https://github.com/qoretechnologies) for Official open-source projects
69
+ - [Discord](https://discord.gg/MWUwDKRR) for support, discussion, news and latest release updates
70
+ - [Qore Technologies Website](https://www.qoretechnologies.com)
71
+
72
+ ## License
73
+
74
+ By contributing, you agree that your contributions will be licensed under its MIT License.
75
+
76
+ ## References
77
+
78
+ This document was adapted from the open-source contribution guidelines for Reference [Facebook's Guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 Qore Technologies, s.r.o.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ <div align="center">
2
+ <br><br><br>
3
+ <img src="./public/logo.png" alt="Unstated Logo" width="500">
4
+ <br><br><br>
5
+ </div>
6
+
7
+ # @qoretechnologies/toolkit-react
8
+
9
+ > A toolkit for building React applications with Qore Technologies standards and best practices. A collection of reusable components, hooks, and utilities.
10
+
11
+ ## Installation
12
+
13
+ Before installing, [download and install Node.js](https://nodejs.org/en/download/).
14
+ Latest stable Node.js is required.
15
+
16
+ Install the library using
17
+
18
+ ```console
19
+ $ yarn add @qoretechnologies/toolkit-react
20
+ ```
21
+
22
+ ## Features
23
+
24
+ ## Community
25
+
26
+ - [GitHub Organization](https://github.com/qoretechnologies) for Official open-source projects
27
+ - [Discord](https://discord.gg/T7vgS6nh) for support, discussion, news and latest release updates
28
+
29
+ ## Examples
30
+
31
+ ## Contributing
32
+
33
+ The Qorus-Toolkit project welcomes all constructive contributions. Contributions can be of many forms including bug fixes, enhancements, fixes to documentation, additional tests and more!
34
+
35
+ See the [Contributing Guide](CONTRIBUTING.MD) for more technical details on contributing.
36
+
37
+ ### Security Issues
38
+
39
+ If you discover a security vulnerability in this library, please see [Security Policies and Procedures](SECURITY.md).
40
+
41
+ ## License
42
+
43
+ [MIT](LICENSE)
package/SECURITY.md ADDED
@@ -0,0 +1,3 @@
1
+ # Reporting and Fixing Security Issues
2
+
3
+ Please do not open GitHub issues or pull requests - this makes the problem immediately visible to everyone, including malicious actors. Security issues in Reqore can be safely reported via email <b>security@qoretechnologies.com</b>