{"id":17473763,"url":"https://github.com/ispyhumanfly/avian","last_synced_at":"2026-03-11T04:31:34.520Z","repository":{"id":27439004,"uuid":"105422306","full_name":"ispyhumanfly/avian","owner":"ispyhumanfly","description":"Create Enterprise-class component driven applications that scale.","archived":false,"fork":false,"pushed_at":"2025-11-17T16:01:24.000Z","size":6374,"stargazers_count":4,"open_issues_count":44,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-12-21T23:49:42.080Z","etag":null,"topics":["application-server","bunyan","component-architecture","enterprise","fluentd","html5","json","redis","scale","stateless","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ispyhumanfly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-10-01T05:52:10.000Z","updated_at":"2025-05-18T15:13:16.000Z","dependencies_parsed_at":"2023-12-24T19:55:15.483Z","dependency_job_id":"1648d76f-73aa-4937-aa40-bf295a1512ae","html_url":"https://github.com/ispyhumanfly/avian","commit_stats":{"total_commits":714,"total_committers":5,"mean_commits":142.8,"dds":0.4607843137254902,"last_synced_commit":"691265016e669461bc067f0acb5280981bcc45d5"},"previous_names":["ispyhumanfly/avian","flypapertech/avian"],"tags_count":158,"template":false,"template_full_name":null,"purl":"pkg:github/ispyhumanfly/avian","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ispyhumanfly%2Favian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ispyhumanfly%2Favian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ispyhumanfly%2Favian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ispyhumanfly%2Favian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ispyhumanfly","download_url":"https://codeload.github.com/ispyhumanfly/avian/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ispyhumanfly%2Favian/sbom","scorecard":{"id":405182,"data":{"date":"2025-08-11","repo":{"name":"github.com/ispyhumanfly/avian","commit":"2013080f93e6632854c2f1e663b6d0d3ca5bda37"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:6","Warn: containerImage not pinned by hash: examples/hello-world/Dockerfile:5: pin your Docker image by updating flypapertech/avian:latest to flypapertech/avian:latest@sha256:b5c1cd00e0530237823ebdbd006d53ea1235cf4873c177ccf9d51b87c077cf72","Warn: npmCommand not pinned by hash: Dockerfile:15-20","Warn: npmCommand not pinned by hash: Dockerfile:15-20","Warn: npmCommand not pinned by hash: Dockerfile:15-20","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   3 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"25 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-3965-hpx2-q597","Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-r5w7-f542-q2j4","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-6hwc-9h8r-3vmf","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp","Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx","Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T21:02:00.879Z","repository_id":27439004,"created_at":"2025-08-18T21:02:00.879Z","updated_at":"2025-08-18T21:02:00.879Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30370797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T21:41:54.280Z","status":"online","status_checked_at":"2026-03-11T02:00:07.027Z","response_time":84,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["application-server","bunyan","component-architecture","enterprise","fluentd","html5","json","redis","scale","stateless","typescript"],"created_at":"2024-10-18T18:07:03.208Z","updated_at":"2026-03-11T04:31:34.512Z","avatar_url":"https://github.com/ispyhumanfly.png","language":"TypeScript","readme":"# Avian\n\nCreate Enterprise-class component driven applications that scale.\n\n[![CircleCI](https://img.shields.io/circleci/build/github/ispyhumanfly/avian/master)](https://circleci.com/gh/ispyhumanfly/avian/tree/master)\n[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/ispyhumanfly/avian)](https://hub.docker.com/repository/docker/ispyhumanfly/avian/builds)\n[![Known Vulnerabilities](https://snyk.io/test/github/ispyhumanfly/avian/badge.svg)](https://snyk.io/test/github/ispyhumanfly/avian)\n[![npm (scoped)](https://img.shields.io/npm/v/spytech/avian.svg)](https://www.npmjs.com/package/spytech/avian)\n[![License](https://img.shields.io/npm/l/spytech/avian.svg)](https://github.com/ispyhumanfly/avian/blob/master/LICENSE)\n[![Dependencies](https://david-dm.org/ispyhumanfly/avian/status.svg)](https://david-dm.org/ispyhumanfly/avian)\n[![Docker Pulls](https://img.shields.io/docker/pulls/ispyhumanfly/avian)](https://hub.docker.com/r/ispyhumanfly/avian)\n\n## Synopsis\n\nAvian is a platform for running highly available, horizontally scalable, stateless, component based applications. It is optimized for public cloud, private cloud, bare metal, virtual machines, and containers. Its design is the result of years of experience in developing and maintaining applications at scale, while easing development and maintainability for large software engineering teams.\n\n## Key Features\n\nAvian is built on top of the popular [Express](https://expressjs.com/) web framework for [NodeJS](https://nodejs.com), uses [Redis](https://redislabs.com/) for managing application state afinity, sessions, and the caching of view templates, while [Webpack](https://webpack.js.org/) manages the transpilation and bundling of your client and server-side component files.\n\n- Cluster mode for load balancing across available CPU cores.\n- Out of the box webpacking with sane defaults. Don't worry you can override and/or add to them whenever you want :)\n- Routes are generated based on how your component folders are structured.\n- Supports client side scripts and server side routes (APIs) written in JavaScript and TypeScript.\n- The serving of static files.\n- Views can be authored in EJS, Twig, Pug, and plain HTML.\n- Logging frameworks are Pino, Bunyan, and Fluentd.\n\n## Installation\n\n### Docker\n\nOfficial Docker instructions coming soon. For now, check out the hello-world example in the examples directory. \n\n### NPM\n\nThe latest stable release of Avian is available on [npmjs.com](https://www.npmjs.com/package/spytech/avian).\n\nThe most common scenario is to install Avian as a dependency of your project.\n\n    npm install @spytech/avian\n\n    or \n\n    yarn add @spytech/avian\n\nAnd can be accessed as...\n\n    node ./node_modules/.bin/avian\n\nAlternatively, Avian can be installed globally, making it possible to serve multiple applications with a single installation of Avian.\n\n    npm install @spytech/avian -g\n\n    or\n\n    yarn global add @spytech/avian\n\nAnd can be accessed globally, but will need to be told where your Avian application is located...\n\n    avian --home /path/to/avian/app/home\n\n### System Requirements\n\n#### NodeJS\n\nAvian requires NodeJS version 8.0 and above.\n\n#### Redis Server\n\nAvian uses Redis Server for storing session data, caching component config object requests and arbitrary caching requirements you may have.\n\nSuggested Redis Installation Methods\n\n##### macOS\n`brew install redis`\n##### Ubuntu Linux\n`apt install redis-server`\n##### Alpine Linux\n`apk add redis`\n##### Windows (experimental)\n  - [Windows with WSL (10 and higher)](https://redislabs.com/blog/redis-on-windows-10/)\n  - [Windows without WSL (8.1 and lower)](https://redislabs.com/blog/redis-on-windows-8-1-and-previous-versions/)\n    - Note: It is not recommended to use Redis in production on Windows with out WSL.\n\n## Getting Started\n\n### CLI Arguments\n\n    Options:\n    --help                      Show help                                [boolean]\n    --version                   Show version number                      [boolean]\n    --name, -n                  The name of your application[default: \"localhost\"]\n    --home, -h                  The directory of your application.\n                                                [default: Current working directory]\n    --mode, -m                  Deployment mode to run Avian in.\n                    [choices: \"development\", \"production\"] [default: \"development\"]\n    --port, -p                  Which port to serve your application on.\n                                                                    [default: 8080]\n    --staticDir, --sd           Which directory you would like to serve static\n                                files from. Will be accessible at the root of your\n                                application (e.g. /).          [default: \"static\"]\n    --entrypoint, --ep          The point of entry to your application.\n                                                                [default: \"index\"]\n    --spa                       Start Avian in a single-page-application (SPA)\n                                configuration.          [boolean] [default: false]\n    --bundleSkip                                        [boolean] [default: false]\n    --bundleOnly                                        [boolean] [default: false]\n    --redisHost                                             [default: \"127.0.0.1\"]\n    --redisPort                                                    [default: 6379]\n    --redisPass\n    --redisSessionDb                                                  [default: 1]\n    --redisCacheDb                                                    [default: 2]\n    --redisCronSchedulerDb                                            [default: 3]\n    --webpackHome                                                    [default: \"\"]\n    --logger, -l                Which logging framework to use.\n                                            [choices: \"pino\", \"bunyan\", \"fluent\"]\n    --loggerFluentLabel, --lfl                                  [default: \"debug\"]\n    --loggerFluentTag, --lft                                    [default: \"debug\"]\n    --loggerFluentHost, --lfh                               [default: \"127.0.0.1\"]\n    --loggerFluentPort, --lfp                                     [default: 24224]\n    --sslCert                                                             [string]\n    --sslKey                                                              [string]\n    --compression                                       [boolean] [default: false]\n    --cronJobScheduler, --cjs   Avian components are capable of scheduling\n                                cron-like jobs that are executed on the server.\n                                                        [boolean] [default: false]\n\n### Application Folder Structure\n\n    ├── assets [optional, statically served at /assets]\n    ├── static [optional, statically served at /static]\n    ├── cache [auto-generated by Avian in production mode to hold cached files]\n    ├── components\n    │   ├── server.routes.(ts/js) [optional, used to add server routes to / path]\n    │   ├── component_name.client.(ts/js) [optional, contains all JavaScript/TypeScript logic for a component. Will be bundled with Webpack]\n    │   ├── component_name.view.(pug/ejs/html) [optional, renders output to a screen, e.g. a /component_name get request]\n    │   ├── component_name.server.routes.*.(ts/js) [optional, used to add server routes to /component_name]\n    │   ├── component_name.config.json [optional, served at /component_name/config/objects.json and passed to view files at render time]\n    │   ├── component_name [components can be in a flat folder or scaffolded like this]\n    │   │   ├── component_name.client.(ts/js)\n    │   │   ├── component_name.view.(pug/ejs/html)\n    │   │   ├── component_name.server.routes.*.(ts/js)\n    │   │   ├── component_name.config.json\n    ├── logs [auto-generated by Avian in production mode]\n    ├── package.json\n    ├── private [auto-generated by Avian to contain server side compiled files, e.g. component server files]\n    ├── public [auto-generated, for compiled component bundles, statically served at /]\n\n### Session Management\n\nAvian uses [express-session](https://github.com/expressjs/session) to manage client sessions. All sessions are stored in a Redis store.\n\n- Browser Based Clients\n  - Avian uses secure [HttpOnly Cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#Secure_and_HttpOnly_cookies) for managing browser based client sessions.\n\n- Mobile Device and API Clients\n  - Avian augments express-session to allow API and mobile device sessions management.  Since those clients may not use cookies they simply need to send their session ID in the authorization header of all requests made to Avian. See below for an example header.\n\n```json\nheaders: {\n    Authorization: \"Bearer Session_ID\"\n}\n```\n\n### Global Variables Added by Avian\n\n#### Properties Added to All Request Objects\n\n`req.argv` contains a copy of all arguments passed to Avian at start time.\n\n`req.cache` is a RedisClient instance hooked to Avian's config object cache. Feel free to use it for your own needs as well.\n\n`req.params` paramaters passed to your component. Typically this is used to determine the component name being rendered, e.g. req.params.component.\n\n`req.query` contains all query parameters passed to the componenent being requested.\n\n#### Developing w/ TypeScript\n\nTo make TypeScript aware of the globals Avian adds to your application simply place the below import into any .d.ts file that is within your application.\n\n```typescript\nimport * as Avian from \"spytech/avian\"\n```\n\n## Examples\n\nExamples are located in the [examples directory](https://github.com/ispyhumanfly/avian/tree/master/examples).\n\n## Contributors\n\n    Dan Stephenson\n    Nick Fredricks\n\n## License\n\n    MIT\n\n## Copyright\n\n    2018 - 2020 FlyPaper Technologies, LLC\n    2016 - 2018 Thoughtpivot, LLC\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fispyhumanfly%2Favian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fispyhumanfly%2Favian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fispyhumanfly%2Favian/lists"}