Skip to content

Commit e8b4bdc

Browse files
m7rlinm7rlin
committed
first release
1 parent e3203cf commit e8b4bdc

20 files changed

+13655
-8
lines changed

‎.editorconfig

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[{package.json,*.yml}]
12+
indent_style = space
13+
indent_size = 2
14+
15+
[*.md]
16+
trim_trailing_whitespace = false

‎.github/workflows/release.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
jobs:
9+
release:
10+
name: 🚀 release
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
steps:
15+
- name: 📚 checkout
16+
uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0
19+
- name: create release
20+
uses: ncipollo/release-action@v1
21+
with:
22+
generateReleaseNotes: true
23+
- name: 🟢 node
24+
uses: actions/setup-node@v3
25+
with:
26+
node-version: 18
27+
registry-url: https://registry.npmjs.org
28+
- name: 🚀 publish to NPM
29+
run: npm publish --access public
30+
env:
31+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

‎.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
node_modules
5+
.pnp
6+
.pnp.js
7+
8+
# testing
9+
coverage
10+
11+
# production
12+
dist
13+
14+
# misc
15+
.DS_Store
16+
*.pem
17+
18+
# debug
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# local env files
24+
.env

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
message="chore(release): %s"

‎.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist
2+
coverage

‎.prettierrc

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"endOfLine": "lf",
3+
"tabWidth": 4,
4+
"printWidth": 100,
5+
"singleQuote": true,
6+
"trailingComma": "es5",
7+
"semi": false
8+
}

‎LICENSE

+504
Large diffs are not rendered by default.

‎LOGO-LICENSE

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
LICENSE FOR LOGO OF MARCIN STAWOWCZYK IN MAGICTM DEEP POPULATE STRAPI PLUGIN
2+
3+
This license applies solely to the logo owned by Marcin Stawowczyk (hereinafter referred to as "Licensor") and used in the open source project called "MagicTM Deep Populate Strapi Plugin" (hereinafter referred to as "Project").
4+
5+
1. Grant of License
6+
Licensor hereby grants to any person or entity using the Project a non-exclusive, non-transferable, and non-sublicensable license to use the Licensor's logo solely for the purpose of identifying the Project and its associated products or services.
7+
8+
2. Restrictions on Use
9+
The license granted in Section 1 is subject to the following restrictions:
10+
11+
- The logo may not be used for any commercial purpose without obtaining prior written permission from the Licensor.
12+
- The logo may not be modified or altered in any way.
13+
- The logo may not be used in any way that suggests or implies endorsement or sponsorship by the Licensor of any third-party product or service.
14+
- The logo may not be used in any way that is illegal, defamatory, or otherwise harmful to the reputation of the Licensor.
15+
16+
3. Ownership
17+
The Licensor retains all right, title, and interest in and to the logo, and any goodwill associated therewith shall inure solely to the benefit of the Licensor.
18+
19+
4. Termination
20+
This license may be terminated by the Licensor at any time upon written notice to the licensee. Upon termination, the licensee must immediately cease using the logo in any way.
21+
22+
5. No Warranty
23+
The Licensor makes no warranties regarding the logo, express or implied, including but not limited to any implied warranties of merchantability or fitness for a particular purpose.
24+
25+
6. Limitation of Liability
26+
The Licensor shall not be liable for any direct, indirect, incidental, consequential, or special damages arising out of or in connection with the use of the logo, even if advised of the possibility of such damages.
27+
28+
7. Governing Law
29+
This license shall be governed by and construed in accordance with the laws of the jurisdiction in which the Licensor resides.
30+
31+
8. Entire Agreement
32+
This license constitutes the entire agreement between the parties with respect to the use of the logo and supersedes all prior or contemporaneous understandings or agreements, whether written or oral.
33+
34+
By using the Licensor's logo in the Project, the licensee acknowledges and agrees to be bound by the terms and conditions of this license.

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,30 @@ Strapi v4 - (current) - v1.x
2828

2929
Tested on Strapi v4.25.4.
3030

31-
## 💻 1. Install
31+
## 💻 Install
3232

33-
### Install the plugin
33+
### 1. Install the plugin
3434

3535
```bash
3636
npm install @magictm/strapi-plugin-deep-populate
3737
```
3838

39-
## 2. Enable the plugin
39+
### 2. Enable the plugin
4040

4141
Navigate to your Strapi project's configuration file:
4242
`<strapi app root>/config/plugins.js` or `.ts`
4343

4444
Add the following code snippet:
4545

46-
### Minimal configuration:
46+
#### Minimal configuration:
4747

4848
```ts
4949
'magictm-deep-populate': {
5050
enabled: true,
5151
}
5252
```
5353

54-
### Advanced configuration
54+
#### Advanced configuration
5555

5656
```ts
5757
'magictm-deep-populate': {
@@ -73,7 +73,7 @@ Add the following code snippet:
7373
}
7474
```
7575

76-
### Full example (typescript)
76+
#### Full example (typescript)
7777

7878
```ts
7979
export default () => ({
@@ -85,15 +85,15 @@ export default () => ({
8585
})
8686
```
8787

88-
## 3. (Re)Start Your Application
88+
### 3. (Re)Start Your Application
8989

9090
For the changes to take effect, restart your Strapi application:
9191

9292
```
9393
npm run develop
9494
```
9595

96-
## 4. 🚀 Usage
96+
## 🚀 Usage
9797

9898
The MagicTM Deep Populate plugin seamlessly integrates with your existing Strapi API. Here's how to use it:
9999

‎assets/logo.svg

+47
Loading

‎package.json

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
{
2+
"version": "0.0.0",
3+
"type": "commonjs",
4+
"exports": {
5+
"./strapi-server": {
6+
"types": "./dist/server/src/index.d.ts",
7+
"source": "./server/src/index.ts",
8+
"import": "./dist/server/index.mjs",
9+
"require": "./dist/server/index.js",
10+
"default": "./dist/server/index.js"
11+
},
12+
"./package.json": "./package.json"
13+
},
14+
"files": [
15+
"dist",
16+
"strapi-server.js"
17+
],
18+
"scripts": {
19+
"build": "strapi plugin:build --force",
20+
"watch": "strapi plugin:watch",
21+
"watch:link": "strapi plugin:watch:link",
22+
"verify": "strapi plugin:verify --debug",
23+
"test:ts:back": "run -T tsc -p server/tsconfig.json",
24+
"npm:publish": "npm publish --access public"
25+
},
26+
"dependencies": {
27+
"@mobily/ts-belt": "^3.13.1",
28+
"@strapi/design-system": "^1.19.0",
29+
"@strapi/helper-plugin": "^4.25.4",
30+
"@strapi/icons": "^1.19.0"
31+
},
32+
"devDependencies": {
33+
"@strapi/strapi": "^4.25.4",
34+
"@strapi/typescript-utils": "^4.25.4",
35+
"@types/react": "^18.3.3",
36+
"@types/react-dom": "^18.3.0",
37+
"@types/react-router-dom": "^5.3.3",
38+
"@types/styled-components": "^5.1.32",
39+
"@types/uuid": "^10.0.0",
40+
"prettier": "^3.3.3",
41+
"react": "^18.3.1",
42+
"react-dom": "^18.3.1",
43+
"react-intl": "^6.6.8",
44+
"react-router-dom": "^5.3.4",
45+
"styled-components": "^5.3.3",
46+
"typescript": "^5.5.3"
47+
},
48+
"peerDependencies": {
49+
"@strapi/strapi": "^4.25.4",
50+
"react": "^18.3.1",
51+
"react-dom": "^18.3.1",
52+
"react-router-dom": "^5.2.0",
53+
"styled-components": "^5.2.1"
54+
},
55+
"strapi": {
56+
"kind": "plugin",
57+
"name": "magictm-deep-populate",
58+
"displayName": "Deep populate by MagicTM (m7rlin)",
59+
"description": "Adds better deep populate support for Strapi."
60+
},
61+
"name": "@magictm/strapi-plugin-deep-populate",
62+
"description": "Adds better deep populate support for Strapi.",
63+
"license": "LGPL-2.1",
64+
"author": "Marcin Stawowczyk m7rlin <merlin@magictm.com>",
65+
"maintainers": [
66+
{
67+
"name": "Marcin Stawowczyk m7rlin <merlin@magictm.com>"
68+
}
69+
],
70+
"engines": {
71+
"node": ">=18.x.x <=20.x.x",
72+
"npm": ">=10.0.0"
73+
},
74+
"repository": {
75+
"type": "git",
76+
"url": "git+https://github.com/magictm/strapi-plugin-deep-populate.git"
77+
},
78+
"bugs": {
79+
"url": "https://github.com/magictm/strapi-plugin-deep-populate/issues"
80+
},
81+
"homepage": "https://github.com/magictm/strapi-plugin-deep-populate#readme",
82+
"keywords": [
83+
"strapi",
84+
"strapi v4",
85+
"strapi plugin",
86+
"strapi deep populate",
87+
"magictm",
88+
"m7rlin",
89+
"strapi nested data",
90+
"simplify api responses",
91+
"strapi community"
92+
]
93+
}

0 commit comments

Comments
 (0)