@clement_lores/adminjs 7.8.17

package/.babelrc.json

@@ -0,0 +1,26 @@
+{
+  "presets": [
+    "@babel/preset-react",
+    ["@babel/preset-env", {
+      "targets": {
+        "node": "18"
+      },
+      "loose": true,
+      "modules": false
+    }],
+    ["@babel/preset-typescript"]
+  ],
+  "plugins": [
+    "@babel/plugin-syntax-import-assertions"
+  ],
+  "only": ["src/", "spec/"],
+  "ignore": [
+    "src/frontend/assets/scripts/app-bundle.development.js",
+    "src/frontend/assets/scripts/app-bundle.production.js",
+    "src/frontend/assets/scripts/global-bundle.development.js",
+    "src/frontend/assets/scripts/global-bundle.production.js"
+  ],
+  "generatorOpts": {
+    "importAttributesKeyword": "with"
+  }
+}

package/.cspell.json

@@ -0,0 +1,16 @@
+{
+    "version": "0.1",
+    "language": "en",
+    "words": [
+        "crossorigin", "nullish", "envs", "prefetch", "expressjs", "icomoon", "populator", 
+        "unflatten", "datetime", "richtext", "promisify", "hoverable", "dropdown", "flatpickr", 
+        "codecov", "bulma", "unmount", "testid", "woff", "iife", "sourcemap", "Roboto",
+        "camelize", "datepicker", "camelcase", "fullwidth", "wysiwig", "Helvetica", "Neue",
+        "Arial", "nowrap", "textfield", "scrollable", "flexbox", "treal", "xxxl",
+        "adminjs", "Checkmark", "overridable", "Postgres", "Hana", "Wojtek", "Krysiak", "bigint",
+        "borderless", "metadetaksamosone", "esrever", "jsnext", "Никита"
+    ],
+    "ignorePaths": [
+        "src/frontend/assets/**/*"
+    ]
+}

package/.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

package/.eslintrc.cjs

@@ -0,0 +1,116 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'mocha'],
+  env: {
+    es6: true,
+    node: true,
+    mocha: true,
+  },
+  extends: ['airbnb', 'plugin:@typescript-eslint/recommended', 'plugin:mocha/recommended', 'plugin:import/typescript'],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  rules: {
+    'react/jsx-filename-extension': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    indent: ['error', 2],
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/ban-ts-ignore': 'off',
+    'import/prefer-default-export': 'off',
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'never'],
+    'import/no-unresolved': 'off',
+    'func-names': 'off',
+    'no-underscore-dangle': 'off',
+    'guard-for-in': 'off',
+    'no-restricted-syntax': 'off',
+    'no-await-in-loop': 'off',
+    'object-curly-newline': 'off',
+    'import/extensions': [2, 'ignorePackages'],
+    'mocha/no-hooks-for-single-case': 'off',
+    'no-param-reassign': 'off',
+    'default-param-last': 'off',
+    'no-use-before-define': 'off',
+    'no-restricted-exports': 'off',
+    'react/require-default-props': 'off',
+    'react/jsx-props-no-spreading': 'off',
+    'react/function-component-definition': 'off',
+    'max-classes-per-file': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    'import/no-import-module-exports': 'off',
+  },
+  ignorePatterns: [
+    '*/build/**/*',
+    '*.json',
+    '*.txt',
+    '*.md',
+    '*.lock',
+    '*.log',
+    '*.yaml',
+    '**/*/frontend/assets/**/*',
+    '*.d.ts',
+    '*.config.js',
+  ],
+  overrides: [
+    {
+      files: ['*-test.js', '*.spec.js', '*-test.ts', '*.spec.ts', '*.spec.tsx', '*.factory.ts', '*.factory.js'],
+      rules: {
+        'no-unused-expressions': 'off',
+        'func-names': 'off',
+        'prefer-arrow-callback': 'off',
+        'import/no-extraneous-dependencies': 'off',
+        'mocha/no-mocha-arrows': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+      },
+    },
+    {
+      files: ['*.jsx', '*.js'],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': 'off',
+      },
+    },
+    {
+      files: ['*.cjs'],
+      rules: {
+        'import/no-commonjs': 'off',
+      },
+    },
+    {
+      files: ['*.tsx'],
+      rules: {
+        'react/prop-types': 'off',
+        'react/function-component-definition': 'off',
+      },
+    },
+    {
+      files: ['**/*/cypress/integration/**/*.spec.js', './cy/**/*.js'],
+      rules: {
+        'mocha/no-mocha-arrows': 'off',
+        'spaced-comment': 'off',
+      },
+    },
+  ],
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
+      },
+    },
+  },
+  globals: {
+    expect: true,
+    factory: true,
+    sandbox: true,
+    server: true,
+    window: true,
+    AdminJS: true,
+    flatpickr: true,
+    FormData: true,
+    File: true,
+    cy: true,
+    Cypress: true,
+  },
+}

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,66 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - octocat
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: Please visit our Discord channel [Discord](https://adminjs.page.link/discord) or leave your email.
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "List what you are trying to do?"
+    validations:
+      required: true
+  - type: input
+    id: prevalence
+    attributes:
+      label: Bug prevalence
+      description: "How often do you or others encounter this bug?"
+      placeholder: "Example: Whenever I visit the personal account page (1-2 times a week)"
+    validations:
+      required: true
+  - type: textarea
+    id: versions
+    attributes:
+      label: AdminJS dependencies version
+      description: "Provide to us a list of dependencies from package.json "
+      placeholder: "Copy exact versions of plugins that you are currently using"
+    validations:
+      required: true
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers do you see the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output or drag&drop screenshot of code. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+  - type: textarea
+    id: code
+    attributes:
+      label: Relevant code that's giving you issues
+      description: Please copy and paste any relevant code or drag&drop screenshot of code. This will be automatically formatted into code, so no need for backticks.
+      render: TypeScript

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,48 @@
+---
+name: 🛠️ Feature Request
+description: Suggest an idea to help us improve AdminJS
+title: "[Feature]: "
+labels:
+  - "feature_request"
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thanks :heart: for taking the time to fill out this feature request report!**
+        We kindly ask that you search to see if an issue [already exists](https://github.com/SoftwareBrothers/adminjs#:~:text=OpenSource%20SoftwareBrothers%20community-,Join%20the%20community,-to%20get%20help) for your feature.
+
+        We are also happy to accept contributions from our users. For more details see [here](https://github.com/SoftwareBrothers/adminjs/blob/master/CONTRIBUTING.md).
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: |
+        A clear and concise description of the feature you're interested in.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Suggested Solution
+      description: |
+        Describe the solution you'd like. A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: |
+        Describe alternatives you've considered.
+        A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: |
+        Add any other context about the problem here.
+    validations:
+      required: false

package/.github/workflows/push.yml

@@ -0,0 +1,167 @@
+name: CI/CD
+on: [push, pull_request]
+
+jobs:
+  setup:
+    name: setup
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'yarn'
+      - name: Install
+        run: yarn install --frozen-lockfile
+
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    needs: setup
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'yarn'
+      - name: Install
+        run: yarn install
+      - name: Assets cache
+        uses: actions/cache@v3
+        id: assets-cache
+        with:
+          path: src/frontend/assets/scripts
+          key: assets-${{ hashFiles('**/src/frontend/global-entry.js') }}-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('**/bin/bundle-globals.js') }}
+          restore-keys: |
+            assets-
+      - name: build
+        run: yarn build
+      - name: types
+        run: yarn types
+      - name: bundle globals production
+        if: steps.assets-cache.outputs.cache-hit != 'true'
+        run: NODE_ENV=production yarn bundle:globals
+      - name: bundle globals dev
+        if: steps.assets-cache.outputs.cache-hit != 'true'
+        run: NODE_ENV=dev yarn bundle:globals
+      - name: bundle production
+        run: NODE_ENV=production ONCE=true yarn bundle
+      - name: bundle dev
+        run: ONCE=true yarn bundle
+      - name: Upload Build
+        if: |
+          contains(github.ref, 'refs/heads/master')
+          || contains(github.ref, 'refs/heads/beta-v7')
+          || contains(github.ref, 'refs/heads/beta')
+        uses: actions/upload-artifact@v4
+        with:
+          name: lib
+          path: lib
+      - name: Upload Types
+        if: |
+          contains(github.ref, 'refs/heads/master')
+          || contains(github.ref, 'refs/heads/beta-v7')
+          || contains(github.ref, 'refs/heads/beta')
+        uses: actions/upload-artifact@v4
+        with:
+          name: types
+          path: types
+      - name: Upload Bundle
+        if: |
+          contains(github.ref, 'refs/heads/master')
+          || contains(github.ref, 'refs/heads/beta-v7')
+          || contains(github.ref, 'refs/heads/beta')
+        uses: actions/upload-artifact@v4
+        with:
+          name: bundle
+          path: lib/frontend/assets/scripts
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs: setup
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'yarn'
+      - name: Install
+        run: yarn install
+      - name: Lint
+        run: yarn lint
+      - name: spell
+        run: yarn cspell
+      - name: install codecov
+        run: yarn global add codecov
+        if: contains(github.ref, 'refs/heads/master')
+      - name: cover
+        if: contains(github.ref, 'refs/heads/master')
+        run: yarn codecov
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      - name: test
+        if: "!contains(github.ref, 'refs/heads/master')"
+        run: yarn test
+
+  publish:
+    name: Publish
+    if: |
+      github.event_name == 'push'
+      && (
+        contains(github.ref, 'refs/heads/master')
+        || contains(github.ref, 'refs/heads/beta-v7')
+        || contains(github.ref, 'refs/heads/beta')
+      )
+    needs:
+      - test
+      - build
+    services:
+      mongo:
+        image: mongo:3.4.23
+        ports:
+          - 27017:27017
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'yarn'
+      - name: Install
+        run: yarn install
+      - name: Download Build
+        uses: actions/download-artifact@v4
+        with:
+          name: lib
+          path: lib
+      - name: Download Types
+        uses: actions/download-artifact@v4
+        with:
+          name: types
+          path: types
+      - name: Download Bundle
+        uses: actions/download-artifact@v4
+        with:
+          name: bundle
+          path: bundle
+      - name: Check directories exists
+        uses: andstor/file-existence-action@v2
+        with:
+          files: "bundle/, lib/, types/"
+          fail: true
+      - name: Release
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          JIRA_TOKEN: ${{ secrets.JIRA_TOKEN }}
+          JIRA_EMAIL: ${{ secrets.JIRA_EMAIL }}
+        run: yarn release

package/.prettierrc

@@ -0,0 +1,21 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "semi": false,
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "options": {
+        "parser": "typescript"
+      }
+    },
+    {
+      "files": "*.css",
+      "options": {
+        "singleQuote": false,
+        "tabWidth": 2
+      }
+    }
+  ]
+}

package/.releaserc

@@ -0,0 +1,29 @@
+{
+  "branches": [
+    "+([0-9])?(.{+([0-9]),x}).x",
+    "master",
+    {
+      "name": "beta",
+      "prerelease": true
+    },
+    {
+      "name": "beta-v7",
+      "prerelease": true
+    }
+  ],
+  "plugins": [
+    ["@semantic-release/commit-analyzer", {
+      "preset": "angular",
+      "releaseRules": [
+        {"type": "feat", "scope": "locale", "release": "patch"},
+        {"type": "feat", "scope": "small", "release": "patch"},
+        {"type": "chore", "scope": "deps", "release": "patch"},
+        {"scope": "no-release", "release": false}
+      ]
+    }],
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    "@semantic-release/git"
+  ]
+}

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Attempting collaboration before conflict
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- Violence, threats of violence, or inciting others to commit self-harm
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, intentionally spreading misinformation, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Abuse of the reporting process to intentionally harass or exclude others
+- Advocating for, or encouraging, any of the above behavior
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us through adminjs@adminjs.co. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+If you are unsure whether an incident is a violation, or whether the space where the incident took place is covered by our Code of Conduct, **we encourage you to still report it**. We would prefer to have a few extra reports where we decide to take no action, than to leave an incident go unnoticed and unresolved that may result in an individual or group to feel like they can no longer participate in the community. Reports deemed as not a violation will also allow us to improve our Code of Conduct and processes surrounding it. If you witness a dangerous situation or someone in distress, we encourage you to report even if you are only an observer.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

package/CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# AdminJS Development
+
+## Explanation of AdminJS libraries
+There are three main terms we use to define AdminJS libraries, which are:
+
+* Core - the main library, containing basically all the logic which you can find in `adminjs` repository
+* Plugin - plugins are wrappers around popular frameworks which allow you to connect AdminJS to your Node.js server and build AdminJS-specific routes. For example `@adminjs/express`.
+* Adapter - adapters are wrappers around supported ORMs and ODMs. They export classes which extend `BaseDatabase`, `BaseResource` and `BaseProperty` components. Their task is to translate AdminJS specific filters/queries to something understandable by your ORM/ODM of choice in order to communicate with the database. For example `@adminjs/typeorm`.
+
+AdminJS also has got it's own design system library (`@clement_lores/admin-design-system`) and a set of premade `features` which you can import into your project (e. g. `@adminjs/passwords`).
+
+## Contributing
+
+### Development
+If you want to contribute to the project, fork repositories you will be working on and after you're done with your changes, open a pull request.
+
+AdminJS team uses [semantic-release](https://github.com/semantic-release/semantic-release) library to automatically create `releases` when a pull request is merged to `master` branch or `pre-releases` when a pull request is merged to `beta` branch. Additionally, based on your commit messages, the library automatically generates a changelog.
+
+Because of this, there is a strict requirement on how you should name your `branches` and `commits`.
+
+Branch names should be prefixed with `fix/`, `chore/`, `feat/` or `test/`.
+
+Commit messages should start with `fix:`, `chore:`, `feat:`, `test:` with the following rules:
+1. When a commit starting with `chore:` or `test:` is merged, it **will not** create a new release.
+2. When a commit starting with `fix:` is merged, a release will be created which upgrades the patch version of the library (example: 6.0.0 -> 6.0.1).
+3. When a commit starting with `feat:` is merged, a release will be created which upgrades the minor version of the library (example: 6.0.1 -> 6.1.0).
+4. When a commit has `BREAKING CHANGE: xxxxx` inside of it's **description**, a release will be created which upgrades the major version of the library (example: 6.1.0 -> 7.0.0).
+5. There are also additional rules defined in `.releaserc`:
+- commits starting with `feat(locale):` and `feat(small):` will only upgrade the patch version despite being `feat` (feature) commits. This type of commit message should be used when you want to create a new translation (`feat(locale)`) or when you add a small feature that doesn't affect the library much (`feat(small)`).
+- commits starting with `chore(deps):` will upgrade the patch version despite being `chore` commits. These are commits automatically created by [dependabot](https://github.com/dependabot) but you should also use this message type when you want to only upgrade a package manually.
+6. When a pull request is merged which contains multiple commit messages, the higher version upgrades take precedence, for example a pull request with `feat:` and `fix:` messages will upgrade the `minor version` (because of `feat: ...` message) but both commit messages will appear in the changelog.
+
+When you work on your bug fixes or new features, make sure they only concern the subject of your pull request. Ideally you would be using `git commit --amend` so that there's only one commit in your pull request.
+If for some reason you want to make more than one change and you need to have multiple commit messages in a pull request, each commit message should only contain changes it refers to.
+
+When a pull request contains a lot of commits without proper messages, we usually `squash` them when merging which can result in a poor release changelog.
+
+### Issues
+When creating an issue please try to describe your problem with as many details as possible. If your issue is a complex one and would require us to reproduce this to respond, a test repository or a code sample which would allow us to reproduce your problem would be ideal.
+If possible, try to create issues by using our issues templates.
+
+### Translations
+
+You can contribute translations via the [fink localization editor](https://fink.inlang.com/github.com/SoftwareBrothers/adminjs).
+
+[![inlang status badge](https://badge.inlang.com/?url=github.com/SoftwareBrothers/adminjs)](https://fink.inlang.com/github.com/SoftwareBrothers/adminjs?ref=badge)
+
+## Developing locally
+
+### Basic example
+To see your changes in your local environment you will, first of all, need a test application. You can clone our [example app](https://github.com/SoftwareBrothers/adminjs-example-app) or create your own.
+
+Next, open terminal in your `adminjs` fork repository, install dependencies and run commands:
+```bash
+$ yarn dev
+$ yarn bundle:globals # re-run it only after you install new dependencies
+```
+After this, run:
+```bash
+$ yarn link
+```
+to register `adminjs` under yarn's linked packages.
+
+Now open terminal in your test application's project and link your local `adminjs` package:
+```bash
+$ yarn link "adminjs"
+```
+You should be able to see your local changes to `adminjs` package in your test application. However, you might have to restart your test application each time you make changes to `adminjs` local package.
+
+### Advanced example
+
+The case described above is the easiest one. Now let's assume you want to make changes to `@clement_lores/admin-design-system` package. This will require you to chain `yarn link` commands:
+
+1. Fork and clone `adminjs-design-system` repository
+2. Install dependencies of `adminjs-design-system` and run `yarn dev`
+3. Register `@clement_lores/admin-design-system` under yarn's linked packages: `yarn link`
+4. Since `@clement_lores/admin-design-system` is a dependency of `adminjs`, open `adminjs` project locally and run:
+```bash
+$ yarn link "@clement_lores/admin-design-system"
+```
+and rebuild it.
+5. Run `yarn link` to register `adminjs` under yarn's linked packages (if you haven't done it before).
+6. Link `adminjs` package in your test application:
+```bash
+$ yarn link "adminjs"
+```
+
+If you try to run your test application now, it should build fine, but you might see some errors when you try to open admin panel in your browser concerning multiple React instances.
+This error occurs because when you install repository's dependencies locally, it will install all of them, meaning you will have `react` installed in your `adminjs-design-system` and `adminjs` folders but you may have only one React instance at a time. The easiest way to solve this would be to use a linked `react` package:
+1. In your test application, run:
+```bash
+$ yarn add react@^18.1.0 react-dom@^18.1.0 styled-components@^5.3.5
+```
+We're also installing `react-dom` and `styled-components` because these two libraries also cause similar issues to `react`.
+2. Navigate to installed `react`, `react-dom` and `styled-components` and register them under yarn linked packages:
+```bash
+$ cd node_modules/react && yarn link
+$ cd ../../node_modules/react-dom && yarn link
+$ cd ../../node_modules/react-i18next && yarn link
+$ cd ../../node_modules/styled-components && yarn link
+```
+3. Now link those packages in your local `adminjs` and `adminjs-design-system` projects:
+```bash
+$ yarn link "react"
+$ yarn link "react-dom"
+$ yarn link "react-i18next"
+$ yarn link "styled-components"
+```
+4. Your test application should now be working.
+
+Having lots of registered packages can bring confusion, you can use the command below to find out which packages you have linked and where they are used:
+```bash
+$ ls -la ~/.config/yarn/link/
+```
+
+`yarn link` documentation: https://classic.yarnpkg.com/en/docs/cli/link
+
+### Alternative to yarn link
+The alternative to `yarn link` is to clone our [adminjs-dev](https://github.com/SoftwareBrothers/adminjs-dev) repository. This repository has all AdminJS packages added as submodules in one [yarn workspace](https://classic.yarnpkg.com/lang/en/docs/workspaces/). The repository's README should be detailed enough to get you started.
+
+Please note that using `yarn workspaces` also has it's issues that we haven't yet resolved. One of them is that all submodules dependencies are installed in the top level (in the root directory of `adminjs-dev`) and installing or updating any new dependency in for example `packages/adminjs` won't update it's `yarn.lock` file and you have to do it manually.
+The upside is that you don't have to deal with `yarn link` dependency issues plus you're able to see your local changes in other submodules in the same workspace immediately.