arun-alagesan/ship

ship

Repo for re writing the site http://seeas.org/ship/index.php building the same with angular 9 with node.js backend api.

ship -> mdb-ui is the angular project cd mdb-ui for the first time run the npm install the dependencies and do npm build && npm start to launch the app in the browser. refer mdb-ui/README.md for instructions

ship -> service-api is the node.js backend api backed up with express.js for serving the api. cd service-api and do npm install for the first time and then npm start

TODO List:

1. Add swagger support for the API docs to servvice-api
2. Change the javascript mode of the service-api to TypeScript to avoid ambigous tyope and strict typing to the code
3. Add docker support for containarization of the UI and Service API for easy deployments
4. Production readiness to add support for build and package of the build artifacts

ship's Issues

Add TypeScript Support to the NodeJS API

Current problem of JavaScript based API causes a lot of typing issues. Its a cumbersome process to sticking to a comment typing in the API end

Objective is to adopt TypeScript at the early stage of development to avoid inconsistencies

Create schema for Voyage Plan

#45 Add the schema for Voyage Plan

Add the DB Component with MySQL

Add the mysql library to the DB component for using it across the business layer

Add a Demo Dash board with a sample charts

Add poc charts with highCharts to demonstrate the dashboard page.
1.A Pie chart
2.A Bar chart
3.A Area chart
4.A Line chart

https://www.highcharts.com/demo

Add login component

Added the login flow with plain db query

API documentation for path: reports/{id}/operations

sub Task of #45

Add the get and post for this endpoint

Add the Business component

Add base DB Script for new Roll out

Add a video to demonstrate the package the app and deployment in Apache

API - Design

Start the API design the with swagger-doc or swaggerhub

visit docs link for updates

[ x ] create swagger hub account
[ x ] add brief over view of the api documentation
[ ] components
[ x ] user
[x] status
[x] response
[x] report
[x] report detail
[x] position
[x] vessel
[ ] endpoints
[x] /
[x] get
[x] /reports
[x] get
[x] put
[x] /reports/{id}
[x] get
[x] post
[x] /vessels
[x] get
[x] put
[x] post

Nested routes for the Deck and Engine section

Nested routes to support navigation with in the Deck and Engine Section

Schema for Engine : Switch Board

• Switch Board
  • • Power Management System
  • • Power Production and Consumption

Add separate tasks for each of this sections for this page

API design for Operations in Report Details

Operations has four sections: and the schema for operation consist of the below

• Create schemas for the below section
  • • #46 Operating time
  • • #48 Operating Condition
  • • #47 Voyage Plan
  • • #49 Position

*Create paths for Operations

• • #50 path: reports/{id}/operations
    * - [ ] #51 get: fetch the operations details for the report id
    * - [ ] #52 put: creates new Operating Time, Operating Condition, Voyager Plan and Position
    * - [ ] #53 post: updates any of the informations related to any or all of the Operations schemas
• • path: operations/{id}
    * - [ ] get: fetch the operations details for the and specified id
    * - [ ] post: updates any of the informations related to any or all of the Operations schemas

Add route controller

ME Lube System Component

Create the ME-Lube System Component

Add a footer section

Footer section with some copy write text

Schema for Engine : Run Hours

• Run Hours
  • • Main Machinery
  • • Auxiliary Machinery 1
  • • Auxiliary Machinery 2
  • • Pump ** can repeat twice ** #Pump1 #Pump2
  • • Deck Machinery

Add separate tasks for each of this sections for this page

Add the Card material templates for the section

Added the sample components for with a card layout

Add the left navigation for create new report

Objective :
When the Create Report is clicked from the tome menu bar new page with left navigation section to be opened.

Header
Observations
Engine
Deck

Tabbed UI for the Deck Section

Just add the Tabbed UI for the Deck on the left Navigation section

Prepare DB Upgrade Scripts for each version release

Tabbed Page for the Engine Section

Just the Page for Engine section with the buttons for sub section

Out let Temperature component

Create the UI Mock of Out let Temperature section

put: path: reports/{id}/operations

sub task of #50

Create the schema spec for the the put operation which includes the parameters, headers, requestBody with the schema specifications of Operating Time, Operating condition, Voyage Plan and Position

API Design for reports end point

Add the design for the operations allowed for reports

path :/reports
get : List all reports
put : new report

path : reports/{id}
get : fetch report by id
post : update report by id

Add JWT based authentication

Now its just a plain db query for authentication.

Add the JWT based authentication to the app.

Changes in both API and Angular UI

get : path: reports/{id}/operations

sub task of #50

Create the required parameters, headers and possible responses for this end point action

Schema for Position

#45 Create schema for position

Vessel Details

Just the UI Mock up of the Vessel Details Section

create new project in swagger hub for seeas

created:

check the swaggerhub link for seeas

Create API Schema for Operating time

sub task of #45

Add a video to demonstrate Dev set up

1. Set up git
2. Set up Node and Angular cli
3. Clone the repo - Angular UI and Node js API
4. build and run the app

Schema for Operating Condition

#45 Write the schema for the Operating Condition

Create boiler plate components

Create just the boiler plate components for all the section in the app

Add a video to demonstrate dev process

1. branch out (feature branch) from the dev branch
2. make changes to the (feature branch)
3. commit and push
4. Create PR to merge feature to Dev Branch

Create swagger hub account

Start the API design the with swagger-doc or swaggerhub

Add a video to demonstrate deployment of the app in the hosting server

Turbo charger UI Component

Just the UI Mock up of the TurboCharger Component

Schema for Engine : Main Engine

• Main Engine
  • Observation can have up to six repetitions
    • • Details
    • • Engine Observations
    • • ME Controls
    • • Air System
    • • ME Lube Oil System
    • • ME Fuel Oil System
    • • Cooling System
    • • Main Engine Exhaust
    • • Turbo Charger
    • • Scavenge Air Sytem
    • • Scavenge Air Coolers
    • • Outlet Temperature
    • • Thrust bearing
    • • Intermediate Shaft Bearing
    • • Stern tube System

Add separate tasks for each of this sections for this page

Create Boiler Component

Boiler component only the UI Mock up

post : path: reports/{id}/operations

sub task of #50
Create the needed schema for parameters, headers, requestBody and responses for the end point

Add the boiler plate Landing pages

For each routes create the boiler plate component to make a functional routes

Add a video to demonstrate API Testing

1. Install Postman
2. Setting up postman project collection
3. Make a get request to the end point
4. Make a post request with params and body to end point
5. Verify results

A menu bar section at the top

Add a menubar section with Home, Reports, Create Report, Settings and My Profile items

Schema for Engine : Auxilary

• Auxilary System
  • • Fuel and Lube oil System
  • • Cooling Water System
  • • Exhaust System
  • • Scavenge System
  • • Alternator

Add separate tasks for each of this sections for this page

Add API design for Vessel as part of vessel details in header

Add the design for the operations allowed for reports
path :/vessels
get : List all vessels
put : new vessel

path : vessels/{id}
get : fetch vessel by id
post : update vessel by id

Add a video to demonstrate the package the app and deployment in IIS

Schema for Engine : Systems

• Systems
  • • Sea Water Systems
  • • Engine Room
  • • Accommodation air temp
  • • Accommodation air Condition
  • • Scrubber
  • • Cooling System
  • • Air
  • • Domestic Reefer
  • • Purifier
  • • Tank Temperature
  • • Fresh Water Generator
  • • Room Temperature

Add separate tasks for each of this sections for this page

Report Details

Report Details components to show the list of reports created

Schema for Engine : Boilers

• • Boilers
• • Boiler Water System

Add separate tasks for each of this sections for this page