Skip to content

Latest commit

 

History

History
276 lines (164 loc) · 9.71 KB

index.md

File metadata and controls

276 lines (164 loc) · 9.71 KB

Ingenious Partners Logo

project's logo

ci-badge

Table of Contents

Overview

CableTrack PRO is the premier tool to enable electricians to quickly and easily create cable schedules for their projects. It allows the tracking of the cable meta-data, pull-ins, terminations, and tests. All of this is designed to allow the electricians to quickly and easily create the Building Information Management (BIM) reports and exports for their projects.

Milestones

CableTrack PRO development is managed via Milestone projects and the issues they contain.

In Milestone 1, we concentrated on laying out foundational functionality, primarily the components that will be used to create the pages.

In Milestone 2, we will be putting together the pages utilizing the components created during M1. This should lead to a second round of page development where we refactor code for re-usability.

In Milestone 3, we instrumented the code with tests and added documentation.

User Guide

Landing Page

The welcome screen that allows the visitor to see what the application is about and give them the opportunity to sign-up or sign-in.

landing page

Sign Up

Ask the user for basic information, such as their email address (username) and desired password.

sign-up page

Sign In

Ask the user for their email address (username) and password.

sign-in page

Sign Out

Signs the user out of the application and redirects them to the Home page.

sign-out page

Edit Profile

Allows the user to update their profile information, such as First and Last Name, Photo URL, etc.

edit profile page

List Companies

Lists companies associated with the user. It provides links to add or edit a company.

list company page

Add Company

Add the Company. This would include fields for Company Name, Logo URL, Address, City, State, ZIP, Country, and associated Users. A new instance is created with a template model.

add company

View Company

View of a specific company with a detailed description about it.

view company

Edit Company

Edit the Company. This would include fields for Company Name, Logo URL, Address, City, State, ZIP, Country, and associated Users. The model is filled from the Company collection using findOne().

edit company

List Users In Company

Shows the users associated with a company.

view company

List Projects

Lists projects associated with the company. It provides links to add or edit a project.

list projects page

Add Project

Add the Project. This would include fields for Project Code, Name, associated Users. A new instance is created with a template model.

add project

View Project

View of a specific project with a detailed description about it.

landing page

Edit Project

Edit the Project. This would include fields for Project Code, Name, associated Users. The model is filled out from the Project collection using findOne().

edit project

List Cables

Lists cables associated with the project. It provides links to add or edit a cable.

list cables page

Add Cable

Add the Cable. This would include fields for Name, Description, Cost Code, etc. A new instance is created with a template model.

add cable

View Cable

View of a specific cable with a detailed description about it.

view cable

Edit Cable

Edit the Cable. This would include fields for Name, Description, Cost Code, etc. The model is filled out from the Cable collection using findOne().

edit cable

List PullIns

Lists pull-ins associated with the cable. It provides links to add or edit a pull-in.

list pull-ins page

Add PullIn

Add the PullIn. This would include fields for Person Installed, Date installed, Length Installed, etc. A new instance is created with a template model.

add pull-in

View PullIn

View of a specific pull-in with a detailed description about it.

view pull-in

Edit PullIn

Edit the PullIn. This would include fields for Person Installed, Date installed, Length Installed, etc. The model is filled out from the PullIn collection using findOne().

edit pull-in

Community Feedback

Feedback 1

It looks good. I think it has everything that’s needed for record keeping and documentation for most of the projects that we do. D. Young, General Foreman, American Electric Company, LLC

Developer Guide

Downloading

First, install Meteor.

Second, go to CableTrack PRO Repository, and click the "Code" button. Select the "Download ZIP" option at the bottom of the menu and save the file to your system.

Installing

Extract the contents of the ZIP file into a directory where you want the project to live. This will create a directory called "cabletrack.pro"; you can rename this directory if you like. Do not use spaces in the directory name or in the path to this directory. If you do, you will get errors when you try to run the application. For example, "cabletrack.pro" is fine, but "cabletrack pro" will not work.

Open a terminal window (Mac) or a command window (Windows), change to the directory containing the project, and install the libraries and frameworks:

$ cd <path-to-directory-containing-project>/app
$ meteor npm install

Running

Once the libraries are installed, you can run the application by invoking the "start" script in the package.json file:

$ meteor npm run start

The first time you run the app, it will create some default users and data. Here is the output:

 meteor npm run start 

> meteor-application-template-react@ start /Users/carletonmoore/GitHub/ICS314/meteor-application-template-react/app
> meteor --no-release-check --exclude-archs web.browser.legacy,web.cordova --settings ../config/settings.development.json

[[[[[ ~/GitHub/ICS314/meteor-application-template-react/app ]]]]]

=> Started proxy.                             
=> Started HMR server.                        
=> Started MongoDB.                           
I20220529-12:09:18.384(-10)? Creating the default user(s)
...
=> Started your app.

=> App running at: http://localhost:3000/

Periodically, you might see Error starting Mongo (2 tries left): Cannot run replSetReconfig because the node is currently updating its configuration after the => Started HMR server.. It doesn't seem to be a problem since the MongoDB does start.

Viewing

If all goes well, the CableTrack PRO application will appear at http://localhost:3000. You can login using the credentials in settings.development.json.