Giter VIP home page Giter VIP logo

cadwolfv9's Introduction

CADWOLF - Angular App

This repo is the angular app for CADWOLF. CADWOLF is a web based engineering platform that integrates documentation, mathematics, data, and a robust part tree system directly with CAD Platforms. The stack for CADWOLF is Laravel on the back end and handling all of the non Angular aspects of the platform, the Angular app, and Google's Firebase for the data.

Visit www.cadwolf.com to get an account and start working.

Our primary CAD integration system is Onshape. We recommend getting an account there and starting to get used to how those systems integrate with ours.

Platform Components

CADWOLF has a number of components which integrate together to create a unique engineering experience. The primary component is the document. A document is similar to a Word document or Google Doc with the addition of a robust system to solve equations and set up for loops, while loops, if statements, and other items such as images videos, and free body diagrams. A document can be used to simultaneously solve and document a mathematical problem or design a component.

One of the other components is the dataset. A dataset is a place where a user can upload, parse, and store data from a text or Excel file. This data can then be pulled into a document for use in equations.

Workspaces are another component. They are essentially folders and allow users to create new files and navigate through subfolders.

Part Trees allow a user to build a tree of items that combine to 'build' a larger structure.

Workflows are a Gantt chart style system where users can control and establish the flow of the design process.

Angular Components

There are a number of primary Angular components within the system that handle the four main components as well as the additional needed items.

  • Workspace
    • Branches
  • Document
  • Dataset
  • Part Tree
  • Teams
  • Units
  • constants
  • Log
  • Profile

Model and Service Patterns

For every database table, there is a corresponding model in the angular app. For each model, there is a service that handles the CRUD aspects of that model. The CRUD commands are all standard except for the read commands. Each model has multiple read commands. One could represent fetching a single model using an ID. Another could represent grabbing all model entries owned by a user, etc.

For each component, there is a corresposing service. These serivces handle all aspects of that component's work that is not related to the fetching of data for the models in use.

In some cases, one service handles both the CRUD for the model and the additional component items. Examples are the Team, Branches, and Log items. In most cases, the model service handles only the CRUD for the model and there are separate services for the components. No CRUD should be done in the component services.

Component Design Pattern

In each compnent, the ngOnInit life cycle hook calls a function named "subscribeToData." That function subscribes to the necessary observables for that component. The ngOnInit hook also calls the necessary functions within the services for those models to retrieve the data.

Models

This is a list of the models in use by CADWOLF. As noted, each model has its own service that handles the various CRUD functions.

  • bases
  • branch
  • cadwolfComponents
  • cadwolfFile
  • constants
  • log
  • permission
  • team
  • teamMember
  • unit
  • users

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

cadwolfv9's People

Contributors

jfoxworth 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.