@teamteanpm2024/exercitationem-veritatis-ipsa

v1.0.5

Published

7 months ago

<h1 align="center">Otter Framework</h1> <p align="center"> <img src="./assets/logo/otter.png" alt="Super cute Otter!" width="40%"/> </p>

Downloads

0High
0Medium
0Low

shivamkalsi2024

arktype crypto clone crypt regular expression ArrayBuffer#slice escape rangeerror rm ES2016 iteration status spec styling argparse airbnb polyfill react-hooks shim HyBi harmony css nesting ES2018 env stringify nested css debug ES2020 await ECMAScript 2015 Array.prototype.contains helpers isConcatSpreadable prototype Object.assign syntax ratelimit loadbalancing ES2015 expression const performance ansi side querystring prefix patch equality AsyncIterator nope positive metadata whatwg define picomatch WebSocket mime includes babel colour zod Observable ECMAScript 3 scheme-validation traverse functions directory buffers queue node glacier util telephone swf query shared xterm es8 ES animation schema react-testing-library jest fast-deep-clone arraybuffer web Streams sham parent callbind wordwrap codes ajv Reflect.getPrototypeOf test serialize rmdir es2018 reduce invariant match fs toSorted jQuery shrinkwrap fp npm assert chai from fastcopy mimetypes lint @@toStringTag hash tslib BigUint64Array agent trim diff dayjs obj typed tc39 styles hooks listeners user-streams superagent call-bound spinners forms classnames Float64Array ECMAScript 2019 transpile tdd unicode jsdiff browser WebSockets compiler pnpm9 watchFile fast terminal has stable collection.es6 optimizer find-up parents some contains ECMAScript 6 weakset ramda circular elasticache toobject inference streams2 browserlist react-hook-form quote json-schema-validator make readablestream Array.prototype.findLast nodejs simpledb cache art slot flags fps package string wait stateless symlinks styleguide storagegateway ArrayBuffer uninstall Int8Array duplex wrap karma type tap efficient es2015 rfc4122 loading exit full-width symlink persistent mixins sigint module BigInt64Array ECMAScript 5 style task stream cors less mixins ESnext ponyfill regular expressions core-js elb rate logging classes array xss __proto__columns ES7 linux json-schema-validation kinesis lazy toStringTag dependency manager byte defineProperty toArray mime-db Map object Object.defineProperty RxJS ie trimLeft javascript Object.fromEntries middleware regex yaml throttle output mapreduce set postcss bundler import break shebang error ec2 command fastify cloudwatch setPrototypeOf inspect let typedarray styled-components performant ECMAScript 2023 fixed-width accessor recursive japanese less css jsdom equal rapid banner typeof Object.entries spring estree three keys wget workspace:*framer shell promises tostringtag tty format less.js number ajax key pretty internal slot internal 6to5 configurable Int32Array route53 flatten assertion ReactiveX values regexp map matchAll fullwidth time serialization prop pipe limited sameValueZero coercible worker minimal rm -rf fast-deep-copy typeerror syntaxerror es-abstract create deepclone a11y pyyaml iam environment immer process extend asserts form-validation Object Array.prototype.flatten compile less bundling valid negative babel-core proto stylesheet io-ts name gestures eslintplugin sequence validator description buffer promise bound call iterate interrupts eventDispatcher setImmediate plugin $.extend computed-types password busy 256 getOwnPropertyDescriptor ES2021 jsx exit-code variables compare JSON find parser typed array handlers generics deep-clone deterministic characters multi-package Object.getPrototypeOf fsevents argv point-free utility ReactiveExtensions native up ArrayBuffer.prototype.slice encryption async delete util.inspect scheme flatMap private random Array.prototype.findLastIndex tape chromium WeakMap structuredClone cloudsearch Float32Array dir sigterm function merge Array.prototype.flat react postcss-plugin ava monorepo superstruct spinner cloudformation Int16Array typanion package.json hasOwn mkdirp path dependencies phone Uint8ClampedArray toolkit ES2022 auth preprocessor make dir config ecmascript TypedArray lockfile view ebs watch emoji push consume redact authentication browserslist Uint32Array byteLength awesomesauce URLSearchParams parsing WeakSet deep-copy filter progress pose groupBy deepcopy mkdir beanstalk datastructure bluebird String.prototype.trim signal autoprefixer ECMAScript 2018 warning ts channel throat ECMAScript 2020 macos RegExp.prototype.flags classname Array.prototype.flatMap autoscaling sanitize gradients css validate TypeScript sanitization file system Symbol joi callbound bootstrap css qs react animation character Stream yup _.extend json-schema http popmotion linewrap class-validator properties less compiler data ender bootstrap less tester waapi Uint16Array link Push installer proxy emit visual iterator walking slice waf serializer cli weakmap symbols css less vpc stringifier typedarrays var glob Array protobuf exec require flat reuse drop xhr east-asian-width ECMAScript 2017 accessibility korean dom-testing-library read intrinsic option extension Object.keys bcrypt rm -fr queueMicrotask which mocha input lru dataview Object.is debugger findLast fast-clone Function.prototype.name byteOffset variables in css command-line drag ECMAScript 7 TypeBox types own ascii es-shims curl dom signals matches sort trimRight tacit chrome safe logger functional gdpr getopt s3 colors group less Microsoft jwt formatting -0 .env symbol aws 3d offset utils is regular sorted mkdirs findup String.prototype.matchAll names column higher-order look call-bind fastclone watcher Symbol.toStringTag Set css-in-js fetch real-time pure es2016 concatMap Object.values jasmine code points dataView check prune core language packages mobile chinese omit length date private data transpiler modules cloudfront color batch once form balanced libphonenumber redux json events hardlinks log eslint console ast amazon https move ECMAScript 2021 open sns es api rds request trimStart args ES5 windows look-up ES2019 preserve-symlinks Array.prototype.includes resolve search es-shim API property getter Underscore StyleSheet flag css redux-toolkit negative zero ES2017 touch JSON-Schema writable enumerable emr value idle validation immutable extra react pose descriptors testing width framework ES2023 YAML every operating-system eslint-plugin speed Observables rgb in getPrototypeOf dynamodb concurrency wordbreak runtime guid

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, @teamteanpm2024/exercitationem-veritatis-ipsa_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/teamteanpm2024/exercitationem-veritatis-ipsa.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.