Code Monkey home page Code Monkey logo

graphvizzer's Introduction

graphvizzer_logo Graphvizzer Add to Slack

Docker Pulls CircleCI Coverage Master Branch

Makes graphs with imgur links directly in your chat channel, instantly, using the popular DOT notation.

View the production version at https://graphvizzer.objectivetruth.ca

View the stage version at http://graphvizzer.stage.objectivetruth.ca

Example Usage

History

I love diagram.. as you can see from this repo. Software is created by people and as the team grows, communication becomes more and more difficult. I use Graphviz alot to communicate ideas and reduce ambiguity. I hope you'll find it helpful too!

replacing the word warfare with software

Fleet Marine Force Manual 1, Warfighting

“Software is a complex endeavor. It is shaped by the human will. It is characterized by friction, uncertainty, fluidity, danger and disorder. While the nature of software is constant, it remains unpredictable, and is affected by a mix of physical, moral and mental factors. While software has the characteristics of both art and science, it is primarily shaped by human experience”.

Architecture

Uses Play2! Scala to communicate between imgur and Slack

Deployment Diagram

Deployment Diagram

Interaction Diagram

Interaction Diagram

Project Setup and Execution

Using Nodejs


  1. Download all dependencies needed using npm install.

  2. The dot command must be runnable from the command line. This utility comes with Graphvizz, which can be installed the following way:

    Ubuntu Install
    $ apt-get install -y graphviz
    
    OSX Install (Homebrew required)
    $ brew install graphviz
    
  3. Start the MongoDB database using the mongod command.

    Note: If MongoDB is not detected, an in-memory MongoDB instance will be created; however, for full functinoality, the above step is preferred.

  4. Run local server by using npm start.

  5. View at localhost:9000 in your browser.

Integration tests

$ npm test

Building the docker

You must be in the project root directory in order to execute the commands below.

  1. Build the Docker image
$ docker build -t objectivetruth/graphvizzer .
  1. Run the Docker image
$ docker run -p 9000:9000 objectivetruth/graphvizzer

License

GNU General Public License v3.0

graphvizzer's People

Contributors

luisarojas avatar objectivetruth 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.