@contentful/react-apps-toolkit 0.1.0
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.
- package/LICENSE +21 -0
- package/README.md +25 -0
- package/package.json +49 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Contentful
|
|
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,25 @@
|
|
|
1
|
+
# In development
|
|
2
|
+
|
|
3
|
+
This library is still in development and should not be used in production.
|
|
4
|
+
|
|
5
|
+
# React Toolkit for Contentful Apps
|
|
6
|
+
|
|
7
|
+
This package consists of helpers and hooks to create a Contentful app with React.
|
|
8
|
+
|
|
9
|
+
This library can be used in apps created by [`create-contentful-app`](https://www.npmjs.com/package/create-contentful-app), but can also be used with any other React app using Contentful's [App SDK](https://www.npmjs.com/package/@contentful/app-sdk).
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```shell
|
|
14
|
+
npm install @contentful/react-apps-toolkit
|
|
15
|
+
# or
|
|
16
|
+
yarn add @contentful/react-apps-toolkit
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Available features
|
|
20
|
+
|
|
21
|
+
The following hooks and utilities are exported from the package: Nothing
|
|
22
|
+
|
|
23
|
+
### Resources
|
|
24
|
+
|
|
25
|
+
- [Create Contentful App](https://www.contentful.com/developers/docs/extensibility/app-framework/create-contentful-app/)
|
package/package.json
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@contentful/react-apps-toolkit",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Toolkit for building a Contentful app in React",
|
|
5
|
+
"keywords": [],
|
|
6
|
+
"author": "Contentful GmbH",
|
|
7
|
+
"license": "MIT",
|
|
8
|
+
"main": "dist/index.js",
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/contentful/create-contentful-app.git",
|
|
12
|
+
"directory": "packages/contentful--react-apps-toolkit"
|
|
13
|
+
},
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/contentful/create-contentful-app/issues"
|
|
16
|
+
},
|
|
17
|
+
"homepage": "https://github.com/contentful/create-contentful-app/tree/master/packages/contentful--react-apps-toolkit#readme",
|
|
18
|
+
"lint-staged": {
|
|
19
|
+
"*.js": [
|
|
20
|
+
"eslint --fix",
|
|
21
|
+
"prettier --write"
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
"files": [
|
|
25
|
+
"dist"
|
|
26
|
+
],
|
|
27
|
+
"scripts": {
|
|
28
|
+
"build": "rimraf dist && tsc",
|
|
29
|
+
"test": "jest",
|
|
30
|
+
"pre-commit": "lint-staged",
|
|
31
|
+
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
|
|
32
|
+
},
|
|
33
|
+
"peerDependencies": {
|
|
34
|
+
"react": ">=16.8.0"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@testing-library/react": "^12.1.3",
|
|
38
|
+
"@testing-library/react-hooks": "^7.0.2",
|
|
39
|
+
"@types/jest": "^27.4.0",
|
|
40
|
+
"@types/react": "^17.0.39",
|
|
41
|
+
"jest": "^27.5.0",
|
|
42
|
+
"ts-jest": "^27.1.3",
|
|
43
|
+
"typescript": "^4.5.5"
|
|
44
|
+
},
|
|
45
|
+
"publishConfig": {
|
|
46
|
+
"access": "public"
|
|
47
|
+
},
|
|
48
|
+
"gitHead": "01a674780aa7356a9f3bcea064ff58a4f24032cb"
|
|
49
|
+
}
|