/skeleton

Automatically generate an integration architecture document for your codebase 🩻

Primary LanguageJavaScript


Logo

Integration Architecture Document Generation

Automatically generate an integration architecture document for your codebase. Currently supporting Express.js
Explore the docs »

View Sample · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Skeleton helps development teams connect and work with each other better without having to know anything about the other's codebase. Imagine two different teams, working on different services. What if Team A wants to integrate with Team B's application? They would need to know the entire integration architecture of Team B's app. This is where Skeleton comes in!

With Skeleton, Team A can instantly and automatically generate a whole document containing all the information needed to connect with Team B's codebase.

Skeleton provides the following information in the document:

  1. All instances of external HTTP APIs.
  2. All the different external libraries and modules being used.
  3. All internal endpoints that Team A can use to connect to Team B.
  4. Security scan for loose API keys and secrets.
  5. Scan results for any outdated libraries and packages.
  6. Scan results for other protocols like FTP, SFTP, and more!

(back to top)

Built With

  • Python
  • JavaScript
  • FastAPI
  • React.js
  • Node.js

(back to top)

Getting Started

Prerequisites

Make sure to have Node.js and Python installed on your system.

  • npm 
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://gitguardian.com
  2. Clone the repo 
    git clone https://github.com/outoflaksh/skeleton.git
  3. Install Python packages 
    pip3 install -r requirements.txt
  4. Enter your API in .env 
    GITGUARDIAN_API_KEY=ENTER YOUR API KEY
  5. Run the following to start the Skeleton API 
    uvicorn api:app

(back to top)

(back to top)

Roadmap

  • Support for more languages and frameworks.
  • More in-depth security scans.
  • A more comprehensive description of all the different endpoints.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Lakshya Malik - @outoflaksh (Twitter, GitHub, Instagram)

Project Link: https://github.com/outoflaksh/skeleton

(back to top)