@devtea2025/distinctio-nesciunt-et-a

v1.0.0

Published

7 months ago

Downloads

0High
0Medium
0Low

valid launch trimEnd Object.entries s3 ES7 ES2020 term Promise urls framework typed jsx spawn regular moment URLSearchParams cloudwatch getPrototypeOf recursive ECMAScript 3 quote wrap option break streams Uint8Array styles opener installer escape functions ES2023 parent iterator String.prototype.trim formatting watch immutable call compiler ReactiveX is number Array.prototype.findLastIndex slot environments structuredClone mkdirs description regular expression glacier fps deep-clone forms jwt prop live ECMAScript 2017 sort wget tap emr setPrototypeOf Int8Array has-own sns Object symlink search Observables encryption exit global symbol Float32Array ES2017 Observable Stream expression deepcopy concat BigUint64Array less css parser predictable cache robust batch includes promises Object.getPrototypeOf exit-code hasOwn fastcopy default JSON protocol-buffers redact css variable format resolve mime-db dependencies view writable typanion runtime sham postcss negative zero command ECMAScript 2022 assert copy minimal link javascript env Array.prototype.includes tdd spinners serialization ses elm URL duplex workspace:*Object.assign prefix hash walk real-time output Underscore child jsonpath byteLength matches file system reducer loadbalancing persistent RFC-6455 private classes chromium fast ECMAScript 2020 jsdiff toolkit byte throat argparse aws callback stringifier internal findLast editor colour getintrinsic define Array.prototype.flatten variables in css logger Uint32Array stylesheet redux WeakSet flux contains length match value ECMAScript 2018 mru react debugger inference form-validation prototype figlet cjk modules bootstrap css prune WeakMap express url extension bound setImmediate ECMAScript 2019 push styling width qs readablestream core-js tostringtag which chinese xhr vpc schema gradients css3 validation buffers streams2 sqs watchFile japanese ECMAScript 2021 es7 256 has assign WebSocket shim read rm -rf weakmap ReactiveExtensions syntaxerror awesomesauce router parents array Function.prototype.name flat iam full-width start ECMAScript 5 sharedarraybuffer bdd write http proto getOwnPropertyDescriptor Array CSSStyleDeclaration entries task flag https react-hooks from once wait connect proxy authentication mime Iterator RxJS elasticache cloudtrail emit Map defineProperty airbnb buffer Object.keys String.prototype.matchAll 0 native es2016 getopt input look-up dotenv concatMap asserts rest character typeerror logging columns test ES8 es5 throttle enumerable TypedArray YAML api date linewrap deep regular expressions setter ratelimit css less art commander ansi ajax es-abstract jshint zod jasmine hookform flatMap website tools xdg pretty slice extend spec warning WebSockets walking inspect helpers ajv codes spinner console fastify clone busy equality Array.prototype.findLast auth ES2022 node require listeners vest fast-deep-copy hardlinks yaml mkdir descriptor flatten file replay groupBy utilities libphonenumber cmd $.extend middleware Uint8ClampedArray ES2019 consume optimizer in fetch merge events scheme collection.es6 module nope ESnext linux Symbol

Description

The Otter project is a highly modular framework whose goal is to provide a common platform to accelerate and facilitate the development on Angular web applications. It is split into several units to cover different aspects of these applications (localization, testing, customization, etc.). Also, to customize an application, metadata can be extracted from the application source code and injected into a CMS to manage dynamic configuration.

[!TIP] The full list of modules and their documentation is available in the /docs folder. An overview of the technical module interactions and the architecture of the dependencies is available in the architecture section.
A demonstration of a list of features provided by Otter is accessible on the showcase application.

Built With

Get Started

A new application can be set up with this simple command:

# Starting a new Otter application
npm create @o3r my-app

[!TIP] Please refer to Otter Get Started and Angular Get Started for complete documentation.

Contributing

Please read the Contributing file for details on our code of conduct and the process to submit pull requests.

Versioning

Please refer to Security file.

License

Please refer to the License file.

Acknowledgments

The Otter Team, @devtea2025/distinctio-nesciunt-et-a_admins, is responsible for the review of the code of this repository. Any bug of feature request can be addressed via issue report.

Developer

Building and Testing library

These documents describe how to set up your development environment to build and test the framework. It also explains the basic mechanics of using git, node, and npm.

Refer to the contribution guidelines if you'd like to contribute to the framework.

Prerequisite Software

Before you can build and test Otter modules, you must install and configure the following products on your development machine:

Git and/or the GitHub app (for Mac or Windows)
- GitHub's Guide to Installing Git is a good source of information.
Node.js, (version >=18.0.0)
- This is used to run tests and generate distributable files. We strongly encourage to use an up-to-date LTS version of Node.js to ensure the support of all the Otter packages. Each package comes with a minimum Node.js version range defined in the engine property of its package.json file.
Yarn, a Node's Package Manager
- You can install yarn using NPM manager (coming with Node.js). The version of Yarn currently used is embedded in the repository and it can be installed using the provided Node.js corepack. In case you need to link this library with your project, you can check the section "Link local packages".
Chrome
- We use Chrome to run our tests.

Getting the sources

Clone the Otter repository using the button Code or using the following git command:

git clone https://github.com/devtea2025/distinctio-nesciunt-et-a.git

Installing NPM modules

Next, install the JavaScript modules needed to build:

# Install library project dependencies (package.json)
yarn install

Build command

To build the modules, run:

yarn run build

Each module can be built independently thanks to Nx commands:

# ex: Build Core package only
yarn nx build core

[!NOTE] Results are put in the dist of each module (packages/@<scope>/<module>/dist).

Running tests locally

Check the formatting:

yarn run lint

Check Unit Tests:

yarn run test

Check Integration Tests:

yarn run test-int

Verdaccio is used to run the integration tests as close as possible to a real npm publication.

Each module can be tested independently thanks to Nx commands:

# ex: Test Core package only
yarn nx test core

# ex: Lint Core package only
yarn nx lint core

Manage task cache

When running the Build, Lint, or Test commands, Nx can use its cache mechanism. In some cases, it may be useful to clear the cache to investigate an issue. This can be done with the following command:

yarn nx reset

Debugging with Visual Studio Code

The repository contains the mandatory configuration and the recommended VSCode plugins to ensure optimal comfort and productivity while developing on the Otter Framework.

The default configuration of the repository provides a way to run Unit Tests one by one and to define, within VSCode, break points using the vscode-jest-tests debugger task.

Link local packages

For Yarn v1, add the resolutions property in the main package.json. It should be filled with the relative path to the dist of the local packages you want to link. The protocol link: can be used.

NOTE: It will not import the transitive dependencies of the linked packages.

Example:

{
  "resolutions": {
    "@o3r/localization": "./relative/path/to/otter/packages/@o3r/localization/dist",
    "@o3r/core": "link:./relative/path/to/otter/packages/@o3r/core/dist",
  }
}

For Yarn v2+, the protocol portal: can also be used.

NOTE: The portal protocol will also import all the transitive dependencies of the linked packages. Please keep in mind that mismatched versions of these dependencies may cause some issues.