npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@aggregion/yaan

v0.13.4

Published

Yet Another Architecture Notation

Downloads

112

Readme

YAAN (Yet Another Architecture Notation)

This project was created so that you can describe all the components of your software, as well as your infrastructure in which it is deployed in a simple declarative form, using YAML or another supported standard format.

YAAN notation can be exported to any representation formats like PlantUML or Structiruzr DSL. Also you can create YAAN from your IaC config files like Terraform, continuous delivery configs and, for example, helm charts / docker-compose files combining them into one schema that can be exported to PlantUML. And you will have an up-to-date visual diagram of the deployments of your entire project.

YAAN uses few base entity types:

  • Solution - describes components (usualy docker-containers) of your solution
  • Server - your server with hardware details
  • Provider - any provider, hosts your infrascturcture
  • KubernetesCluster - describes your cluster
  • Deployment - defines which components on which infrastracture is deployed at the moment
  • Presentation - combines all entities into one view scope. For example, you can have presentation for only your development environment, or prouction or worldwide presentation of all your clusters / servers / solution. Presentations is the ones exported to any visual representation formats.

CI/CD

One of the main goals for which YAAN was created is the ability to minimize manual labor for all changes in your applications or infrastructure. Therefore, YAAN is focused on the fact that the notation will be changed automatically when the application code, the code describing the infrastructure, is changed.

Example workflow:

example workflow

YAAN notation documentation

Detailed description of entities you can read in schema-docs directory.

CLI

This module provides CLI for exporting and validating YAAN projects. Type yaan --help for details.