Giter Club home page Giter Club logo

2020sp-420-webwizards's Introduction

WebWizards UML Editor - Developer Guide

runTest.js CI

Running the application

This application is created with "plain vanilla" HTML, Javascript, and CSS -- so you should be able to clone the repository and open index.html in your favorite web browser.

Directory structure

The root directory has three main subfolders, c, m, and v -- which stand for "control", "model", and "view" respectively. Model and View files should be stand-alone -- i.e., should not be making calls to classes outside their own!

Model files

UMLClass.js

Defines the UMLClass class. Each UMLClass is defined as having a string name, and string arrays vars and methods. UMLClass's for a session are stored in the map ( {} ) UMLClass.instances, and are referenced by name.

So if you created a UMLClass named classOne, you could reference it by calling UMLClass.instances[classOne].

Edge.js

An Edge (relationship between two classes) is defined as having fields start (start class name), end (end class name), and type (type of relationship between the classes). They are stored in the array Edge.instances.

save.js

The functions in this file expect copies of UMLClass.instances and Edge.instances and save and load them to the location localStorage["storage"].

Control files

setUpGUI.js

contains the function pl.c.setUpGUI(), which is called by index.html upon page load. setUpGUI() calls a number of functions in v/guiView.js

parser.js

is largely composed of a switch statement that defines the response to CLI input

View Files

cliView.js

contains logic for handling cli input

guiView.js

contains the logic, buttons, and modals for creating a GUI interface

instrustions.js

contains logic to display instructions to the user

validation.js

2020sp-420-webwizards's People

Contributors

ben-wesley avatar qnjones avatar jusjacs avatar kendall1812 avatar willkill07 avatar

Watchers

James Cloos avatar  avatar  avatar

2020sp-420-webwizards's Issues

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.