Skip to content

Commit

Permalink
fix: packages size optimization #480 #482, error key missing #478 (#484)
Browse files Browse the repository at this point in the history
* fix: packages size optimization #480 #482, error key missing #478

* chore: beta version pipeline as option

* fix: readme resources link to external source

* fix: readme resources link to external source

* chore: cleanup static assets in the repository

Signed-off-by: Mateusz Ziarko <mateusz.ziarko@webninja.eu>

---------

Signed-off-by: Mateusz Ziarko <mateusz.ziarko@webninja.eu>
  • Loading branch information
cyp3rius authored Dec 24, 2024
1 parent 3d4b9f0 commit 5ce2f43
Show file tree
Hide file tree
Showing 12 changed files with 461 additions and 448 deletions.
38 changes: 33 additions & 5 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ jobs:
- restore_cache:
keys:
# when lock file changes, use increasingly general patterns to restore cache
- strapi-plugin-navigation-v4-{{ checksum "yarn.lock" }}
- strapi-plugin-navigation-v4
- strapi-plugin-navigation-1735037133-{{ checksum "yarn.lock" }}
- strapi-plugin-navigation-1735037133
- run:
name: Echo versions
command: |
Expand Down Expand Up @@ -50,7 +50,7 @@ jobs:
- save_cache:
paths:
- ./node_modules
key: strapi-plugin-navigation-v3-{{ checksum "yarn.lock" }}
key: strapi-plugin-navigation-1735037133-{{ checksum "yarn.lock" }}
- persist_to_workspace:
root: ~/repo
paths: .
Expand All @@ -75,7 +75,27 @@ jobs:
- run:
name: Publish package
command: npm publish --tag latest

deployBeta:
environment:
CODECOV_TOKEN: c803c20c-c45d-4a63-9ba9-58c7d5d05bbf
docker:
- image: cimg/node:20.12.2
working_directory: ~/repo
resource_class: large
steps:
- attach_workspace:
at: ~/repo
- run:
name: Configure NPM
command: |
echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ~/.npmrc
- run:
name: Build
command: |
yarn build
- run:
name: Publish package
command: npm publish --tag beta
workflows:
version: 2
test-deploy:
Expand All @@ -89,6 +109,14 @@ workflows:
- test
filters:
tags:
only: /^v.*/
only: /^v\d+\.\d+\.\d+$/
branches:
only: master
- deployBeta:
requires:
- test
filters:
tags:
only: /^v.*-beta\.\d+$/
branches:
ignore: /.*/
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center" width="150px">
<img style="width: 150px; height: auto;" src="public/assets/logo.png" alt="Logo - Strapi Navigation plugin" />
<div align="center" style="max-width: 10rem; margin: 0 auto">
<img style="width: 150px; height: auto;" src="https://www.sensinum.com/img/open-source/strapi-plugin-navigation/logo.png" alt="Logo - Strapi Navigation plugin" />
</div>
<div align="center">
<h1>Strapi - Navigation plugin</h1>
Expand All @@ -21,7 +21,7 @@
---

<div style="margin: 20px 0" align="center">
<img style="width: 100%; height: auto;" src="public/assets/preview.png" alt="UI preview" />
<img style="width: 100%; height: auto;" src="https://www.sensinum.com/img/open-source/strapi-plugin-navigation/preview.png" alt="UI preview" />
</div>

Strapi Navigation Plugin provides a website navigation / menu builder feature for [Strapi Headless CMS](https://github.com/strapi/strapi) admin panel. Navigation has the possibility to control the audience and can be consumed by the website with different output structure renderers:
Expand Down Expand Up @@ -77,7 +77,7 @@ Strapi Navigation Plugin provides a website navigation / menu builder feature fo
As a ✅ **verified** plugin by Strapi team we're available on the [**Strapi Marketplace**](https://market.strapi.io/plugins/strapi-plugin-navigation) as well as **In-App Marketplace** where you can follow the installation instructions.

<div style="margin: 20px 0" align="center">
<img style="width: 100%; height: auto;" src="public/assets/marketplace.png" alt="Strapi In-App Marketplace" />
<img style="width: 100%; height: auto;" src="https://www.sensinum.com/img/open-source/strapi-plugin-navigation/marketplace.png" alt="Strapi In-App Marketplace" />
</div>

### Via command line
Expand All @@ -100,7 +100,7 @@ The **UI Navigation** plugin should appear in the **Plugins** section of Strapi
You can manage your multiple navigation containers by going to the **Navigation** manage view by clicking "Manage" button.

<div style="margin: 20px 0" align="center">
<img style="width: 100%; height: auto;" src="public/assets/manager-view.png" alt="Navigation Manager View" />
<img style="width: 100%; height: auto;" src="https://www.sensinum.com/img/open-source/strapi-plugin-navigation/manager-view.png" alt="Navigation Manager View" />
</div>

As a next step you must configure your the plugin by the way you want to. See [**Configuration**](#🔧-configuration) section.
Expand All @@ -113,7 +113,7 @@ Complete installation requirements are exact same as for Strapi itself and can b

**Supported Strapi versions**:

- Strapi v5.5.1 (recently tested)
- Strapi v5.6.0 (recently tested)
- Strapi v5.x

> This plugin is designed for **Strapi v5** and is not working with v4.x. To get version for **Strapi v4** install version [v4.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v4).
Expand All @@ -129,7 +129,7 @@ To start your journey with **Navigation plugin** you must first setup it using t
On the dedicated page, you will be able to set up all crucial properties which drive the plugin and customize each individual collection for which **Navigation plugin** should be enabled.

<div style="margin: 20px 0" align="center">
<img style="width: 100%; height: auto;" src="public/assets/configuration.png" alt="Plugin configuration" />
<img style="width: 100%; height: auto;" src="https://www.sensinum.com/img/open-source/strapi-plugin-navigation/configuration.png" alt="Plugin configuration" />
</div>

> *Note*
Expand Down
3 changes: 3 additions & 0 deletions admin/src/translations/ca.ts
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ const ca = {
label: "Clé du routeur UI",
placeholder: "Si vide, généré automatiquement par \"Titre\"",
},
uiRouter: {
unableToRender: "Impossible de restituer le slug et/ou la clé du routeur d'interface utilisateur en raison de caractères non pris en charge"
},
path: {
label: "URL",
placeholder: "Partie unique de l'URL identifiant cet élément",
Expand Down
3 changes: 3 additions & 0 deletions admin/src/translations/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ const en = {
label: "UI router key",
placeholder: "If empty, auto generated by \"Title\"",
},
uiRouter: {
unableToRender: "Unable to render slug and/or UI Router Key because of not supported characters"
},
path: {
label: "URL",
placeholder: "Unique url part identifies this item",
Expand Down
3 changes: 3 additions & 0 deletions admin/src/translations/fr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ const fr = {
label: "Clé du routeur UI",
placeholder: "Si vide, généré automatiquement par \"Titre\"",
},
uiRouter: {
unableToRender: "Impossible de restituer le slug et/ou la clé du routeur d'interface utilisateur en raison de caractères non pris en charge"
},
path: {
label: "URL",
placeholder: "Partie unique de l'URL identifiant cet élément",
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "strapi-plugin-navigation",
"version": "3.0.0",
"version": "3.0.1",
"description": "Strapi - Navigation plugin",
"strapi": {
"name": "navigation",
Expand Down Expand Up @@ -40,7 +40,6 @@
}
],
"dependencies": {
"@faker-js/faker": "^9.0.3",
"@sindresorhus/slugify": "1.1.0",
"@tanstack/react-query": "^5.40.0",
"lodash": "^4.17.21",
Expand All @@ -55,16 +54,17 @@
"zod": "^3.22.5"
},
"devDependencies": {
"@faker-js/faker": "^9.0.3",
"@jest/types": "29.5.x",
"@koa/router": "^12.0.1",
"@sensinum/strapi-utils": "^1.0.4",
"@strapi/design-system": "2.0.0-rc.14",
"@strapi/icons": "2.0.0-rc.14",
"@strapi/plugin-graphql": "^5.5.1",
"@strapi/plugin-graphql": "^5.6.0",
"@strapi/sdk-plugin": "^5.2.8",
"@strapi/strapi": "^5.5.1",
"@strapi/types": "^5.5.1",
"@strapi/typescript-utils": "^5.5.1",
"@strapi/strapi": "^5.6.0",
"@strapi/types": "^5.6.0",
"@strapi/typescript-utils": "^5.6.0",
"@types/jest": "^29.5.12",
"@types/koa": "^2.15.0",
"@types/koa-bodyparser": "^4.3.12",
Expand Down Expand Up @@ -101,7 +101,7 @@
},
"peerDependencies": {
"@strapi/sdk-plugin": "^5.2.8",
"@strapi/strapi": "^5.5.1",
"@strapi/strapi": "^5.6.0",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-router-dom": "^6.26.2",
Expand Down
Binary file removed public/assets/configuration.png
Binary file not shown.
Binary file removed public/assets/logo.png
Binary file not shown.
Binary file removed public/assets/manager-view.png
Binary file not shown.
Binary file removed public/assets/marketplace.png
Binary file not shown.
Binary file removed public/assets/preview.png
Binary file not shown.
Loading

0 comments on commit 5ce2f43

Please sign in to comment.