Code Monkey home page Code Monkey logo

berryjam's Introduction

Berryjam

Scan your Vue.js codebase for component visibility and actional insights.

Berryjam is a Vue.js component analytics tool to scan your project for components to monitor their usages. Component visibility allows for effective team communication and provides opportunities to optimize your source code.

Currently supporting JavaScript / TypeScript, Vue.js (3.X) and Nuxt (3.X). The CLI scan is more accurate on TypeScript project.

Overview - Quick Start (to Web Documentation) - Community - Support (to Berryjam Discord) - License

License Discord Twitter

๐Ÿ˜Ž Overview

Berryjam scans for components in your source code to output a JSON file. Here is a sample JSON:

Simple JSON
[
    {
        tag: "Overlay",
        total: 1,
        type: "internal",
        source: {
            filePath: "@/components/ui/Overlay.vue",
            fileProperty: {
                dataLastModified: "",
                lastModified: "",
                created: "",
                createdBy: "",
                updatedBy: ""
            }
        },
        details: [
            {
                source: "/Users/name/folder/koel-master/resources/assets/js/App.vue",
                rows: [2],
                property: {
                    dataLastModified: "",
                    lastModified: "",
                    created: "",
                    createdBy: "",
                    updatedBy: ""
                },
                total: 1,
            },
        ],
        children: {
            total: 0,
            tags: [],
            source: "",
        },
    },
    {
        tag: "DialogBox",
        total: 1,
        type: "internal",
        source: {
            filePath: "@/components/ui/DialogBox.vue",
            fileProperty: {
                dataLastModified: "",
                lastModified: "",
                created: "",
                createdBy: "",
                updatedBy: ""
            }
        },
        details: [
            {
                source: "/Users/name/folder/koel-master/resources/assets/js/App.vue",
                rows: [3],
                property: {
                    dataLastModified: "",
                    lastModified: "",
                    created: "",
                    createdBy: "",
                    updatedBy: ""
                },
                total: 1,
            },
        ],
        children: {
            total: 0,
            tags: [],
            source: "",
        },
    },
];
After the scan, Berryjam triggers your Analytic Dashboard for transparency and insights. Here is a sample Dashboard:

berryjam - dashboard

๐Ÿ‘ฅ Community

  • Twitter: Follow our official Twitter account
  • Discord: A place where you can get support, feedback or just want to meet and hang out.
  • GitHub: If you wish, you may want to request features here too.
  • For any other inquiries, you may reach out to us at [email protected].

๐Ÿ“š License

Berryjam code is licensed under the terms of the Elastic License 2.0 (ELv2), which means you can use it freely inside your organization to protect your applications without any commercial requirements.

You are not allowed to provide Berryjam to third parties as a hosted or managed service without explicit approval.


berryjam's People

Contributors

ansonchieng avatar kittisakls avatar ravut8 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.