Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1374 Patch @strapi/admin to have all sections closed by default #1377

Merged
merged 1 commit into from
Feb 13, 2025
Merged

#1374 Patch @strapi/admin to have all sections closed by default #1377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 24 additions & 107 deletions strapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,142 +1,59 @@
# 🚀 Getting started with Strapi
# 🚀 Strapi

Strapi comes with a full featured [Command Line Interface](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html) (CLI) which lets you scaffold and manage your project in seconds.
## Setup

## 🧰 Setup

Before you start, install all dependencies and create `.env.local` file which is .gitignored used for local dev
Before you start, install all dependencies and create `.env.local` file which is .gitignored and used for local dev.

```
yarn
cp .env.example .env.local
```

You need postgres running locally (with correct credentials & databse available). The default setup is below, you can override any of the variables by passing them in you `.env.local` file. The easiest way to get a postgres db with the right credentials up&running is via `docker-compose.yml` file in the root fo this repo (check the root README).

### Starting from empty database

While not recommended in this project, if you want to start from a clean slate, read (TODO - writing in progress on the doc site).

### Seeding the database

It's recommended that you don't start from an empty database, but instead seed with staging or production data. Ask in the internal Bratislava team or [follow the docs](https://bratislava.github.io/strapi/load-strapi-db-in-local-dev). If you are an open-source contributor, note you do not need this setup for many of frontend-related changes. See the next.js project README.

We may provide a db dump as part of the project in the future - for now please contact the BA Innovations Team if you need it.

### Meilisearch

We're indexing some of our content in [Meilisearch](https://www.meilisearch.com/). We do this using [our fork of strapi-plugin-meilisearch](https://github.com/bratislava/strapi-plugin-meilisearch) - if the credentials within the plugin section of your Strapi UI do not point to a running Meilisearch instance, you'll see an error like this when you start your local server:

```
error: meilisearch: The provided host is not valid.
```

If you're not developing any new search functionality, you likely don't need this and can safely ignore the error. If you think you need this integration, follow [the guide on our docs page](https://bratislava.github.io/docs/bratislava.sk/meilisearch-setup).

You can also setup local meilisearch instance using `docker compose` - see `docker-compose.yml` in the root of the repo and set your `.env.local` vars accordingly.

### `develop`

Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-develop)

```
yarn develop
```

### `start`
You need postgres running locally (with correct credentials & database available). The easiest way to get a postgres db with the right credentials up&running is via `docker-compose.yml` file. Check the readme in the root of this repo.

Start your Strapi application with autoReload disabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-start)

```
yarn start
```

### `build`
## Build

Build your admin panel. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-build)

```
yarn build
```

## Patches

We use [patch-package](https://github.com/ds300/patch-package) to slightly change the behaviour of some packages. See the `patches` folder for more details.
## Start development server

When updating these packages, please run also `patch-package`:
Start your Strapi application with autoReload enabled. [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-develop)

```
yarn patch-package @strapi/plugin-users-permissions
yarn dev
```

## Secrets
## Start server

Let's have a look if you are in the proper cluster:
Start your Strapi application with autoReload disabled (not needed for development). [Learn more](https://docs.strapi.io/developer-docs/latest/developer-resources/cli/CLI.html#strapi-start)

```bash
kubectl config current-context
```

We are using for secrets `Sealed Secrets` https://github.com/bitnami-labs/sealed-secrets.
To use a secret in your project, you have to install `kubeseal` if you haven`t installed it yet.

```bash
brew install kubeseal
```

The next thing is going to the folder `secrets` where all our secrets are stored:

```bash
cd kubernetes/base/secrets
```

After that, we need to create a temp file for our new secrets. Let's assume we want database connection secretes. You need to make this file `database.yml`

```yaml
apiVersion: v1
kind: Secret
metadata:
name: database-secret
data:
POSTGRES_DB: YmFuYW5h
POSTGRES_USER: YmFuYW5h
POSTGRES_PASSWORD: YmFuYW5h
yarn start
```

- `metadata.name` is the name of the group of secrets in our case, `database-secret`

- `data` contains environment variables keys (`POSTGRES_DB`) and base64 encode values (`YmFuYW5h`).
## Set permissions

For example, if you need to set up the database name to `banana`, you need to base64 encode this value. You can use an online base64 converter like https://www.base64encode.org and encode `banana` to `YmFuYW5h`.
To allow graphql queries, you need to give access to Public role:

The last thing is encrypting our secrets by kubeseal to be used on Kubernetes. You need to run this command that creates the file `database.secret.yml` where all our values are encrypted and safe to add to the repository.
Open Strapi admin panel, go to Settings > USERS & PERMISSIONS PLUGIN > Roles > Public. Check `find` and `findOne` for all content types.

```bash
kubeseal --controller-name=sealed-secrets --scope=namespace-wide --namespace=standalone --format=yaml < database.yml > database.secret.yml
```
## Using `patch-package`

If you want to propagate a sealed secret to Kubernetes without a pipeline, you can run this command:
We use `patch-package` to apply patches to dependencies.

```bash
kubectl create -f database.secret.yml
```
### @strapi/admin
> Note: The text below applies for newer versions of Strapi, but I'm keeping it here for future us when we upgrade Strapi.\
> For v4.10.8, you can find DynamicComponent.js in node_modules directly.

If you already have a sealed secret in Kubernetes, you can update it with the command:
Strapi transpiled files are located in `./node_modules/@strapi/[package-name]/dist/_chunks` so it's needed to make the changes and run patch-package on every Strapi upgrade.

We change the default state of Dynamic Zone accordions to closed (see original file [DynamicComponent.tsx](https://github.com/strapi/strapi/blob/11c0ef3bd0937cb32dd5da01e346090d8702dd0b/packages/core/admin/admin/src/content-manager/components/DynamicZone/DynamicComponent.tsx#L57)).
Since the .js files do not have the same structure and names as the .tsx files, we found the proper file by searching for the string from the original file, e.g. `"const [isOpen, setIsOpen] = React.useState(true);"`
and then run the command to create a patch file:
```bash
kubectl apply -f database.secret.yml
```

Usually, you get this kind of error: `Error from server (AlreadyExists): error when creating "database.secret.yml": sealedsecrets.bitnami.com "nest-Prisma-template-database-secret" already exists`

If you want to check if your secret is there, you can run this command:

```bash
kubectl get secret --namespace=standalone nest-prisma-template-database-secret
```

To implement on-demand revalidation, we need to add webhook url from strapi admin panel. The route of the url should be like below:

```
https://<host>/api/revalidate?secret=<STRAPI_REVALIDATE_SECRET_TOKEN>
yarn patch-package @strapi/admin
```
13 changes: 13 additions & 0 deletions strapi/patches/@strapi+admin+4.10.8.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
diff --git a/node_modules/@strapi/admin/admin/src/content-manager/components/DynamicZone/components/DynamicComponent.js b/node_modules/@strapi/admin/admin/src/content-manager/components/DynamicZone/components/DynamicComponent.js
index 21e81e9..0aa503b 100644
--- a/node_modules/@strapi/admin/admin/src/content-manager/components/DynamicZone/components/DynamicComponent.js
+++ b/node_modules/@strapi/admin/admin/src/content-manager/components/DynamicZone/components/DynamicComponent.js
@@ -84,7 +84,7 @@ const DynamicZoneComponent = ({
onDropItem,
onCancel,
}) => {
- const [isOpen, setIsOpen] = useState(true);
+ const [isOpen, setIsOpen] = useState(false);
const { formatMessage } = useIntl();
const { getComponentLayout } = useContentTypeLayout();
const { modifiedData } = useCMEditViewDataManager();
Loading