mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2026-09-02 17:53:30 +00:00
Vito Albano
78661f11c5
* [AAE-46514] - using by default ignore-scripts and have a trusted list for those who are trusted * [AAE-46514] - Improved the checks to cover more cases * [AAE-46514] - Fixed copilot comments * [AAE-46514] - OTher fixes * [AAE-46514] - Fixing other improvements and comments * [AAE-46514] - npmrc should be versioned to enforce the audit * [AAE-46514] - Improved code * [AAE-46514] - Removed the check on CI as we have other tools * [AAE-46514] - Improved check, updated descriptions, skip check on CI as there is already Sonar * [AAE-46514] - Reduced functions in smaller pieces * [AAE-46514] - Migrating to Pnpm to increase safety * [ci:force] - Checking * [ci:force] - Fixed complexity of the scripts * [ci:force] - Fixed complexity of the scripts * [ci:force] - Fixed wrong typing on yml * [ci:force] - Fixed sonar comments and added correct version to sha pinned action * [ci:force] - Fixed cache hit for npmn * [ci:force] - Improved eslint plugin so it can be built with standard action * [ci:force] - Improved eslint plugin so it can be built with standard action * [ci:force] - Added minimatch * [ci:force] - Fixing issues * [ci:force] - Removed 'run' as it is not needed * [ci:force] - Using audit in place of custom scripts * [ci:force] - Fixed vulnerabilities and removed custom scripts in favor of audit --critical * [ci:force] - Added minimum time for publishing to install * [ci:force] - Address issue with too new packages * [ci:force] - Address issue with too new packages
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
# Alfresco Application Development Framework (ADF)
|
|
|
|
## Introduction
|
|
|
|
See the [introduction page](docs/user-guide/adf-introduction.md) in our
|
|
[documentation](docs/README.md) for an overview of ADF along with links
|
|
to useful starting points.
|
|
|
|
## Prerequisites
|
|
|
|
```text
|
|
Node: 18.x
|
|
NPM: 9.x
|
|
```
|
|
|
|
Also, check out the tutorial: [Creating your first ADF Application](docs/tutorials/creating-your-first-adf-application.md)
|
|
for full details on what you may need to install before using ADF.
|
|
|
|
### See also
|
|
|
|
- [Node Version Manager](docs/tutorials/nvm.md)
|
|
- [CORS guide](ALFRESCOCORS.md)
|
|
|
|
## Installation
|
|
|
|
This project uses **pnpm** for package management with built-in supply chain attack protection.
|
|
|
|
```bash
|
|
pnpm install # install all packages
|
|
pnpm run add <package> # add a new package (with security check)
|
|
```
|
|
|
|
### Supply Chain Security
|
|
|
|
**Layer 1: pnpm script blocking**
|
|
- All lifecycle scripts (postinstall, etc.) are blocked by default
|
|
- Only trusted packages in `pnpm-workspace.yaml` can run scripts
|
|
- Protects during `pnpm install` and `pnpm add`
|
|
|
|
**Layer 2: Security database check**
|
|
- `pnpm run add` checks packages against OSV and GitHub Advisory databases BEFORE installing
|
|
- Pre-commit hook blocks commits containing known malicious packages
|
|
|
|
**Layer 3: npm blocked**
|
|
- Running `npm install` will fail - enforces pnpm usage
|
|
|
|
## Components
|
|
|
|
You can find the sources for all ADF components in the [`lib`](/lib) folder.
|
|
|
|
## Libraries
|
|
|
|
ADF Libraries list:
|
|
|
|
- [Content services](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/content-services)
|
|
- [Core](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/core)
|
|
- [Extensions](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/extensions)
|
|
- [Insights](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/insights)
|
|
- [Process Service Cloud](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/process-services-cloud)
|
|
- [Process service](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/process-services)
|
|
- [Stories](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/stories)
|
|
|
|
## Browser Support
|
|
|
|
All components are supported in the following browsers:
|
|
|
|
| **Browser** | **Version** |
|
|
|-------------|-------------|
|
|
| Chrome | Latest |
|
|
| Safari | Latest |
|
|
| Firefox | Latest |
|
|
| Edge | Latest |
|