IBSConstructionManagementProgressTracker | DEV

⚠️ In development

A web-based automated IBS Construction Progress Tracker with Site Diary entry, progress Charts and 3D Model Visualisation of progress. There is a QR/Barcode Scanner that serves as the data entry point for this project. The scanner can be found in one of my repositories under qrscanner.

Development Stack

Core	Tool
Client-side	React JS
Server-side	Express
API-backend	GraphQL
Database	MongoDB
Authentication	Auth0
External BIM APIs	Autodesk Forge
External Chart APIs	Mongo Charts

Getting started locally

• Clone this github repository

Open up a terminal and move to where you want to clone the project on your local machine using the cd (change directory) command and then run the command:

git clone https://github.com/Kwan-Yee/IBSConstructionManagementProgressTracker.git

• cd into the IBSConstructionManagementProgressTracker cloned project directory and install the project dependencies

cd IBSConstructionManagementProgressTracker

npm install

• At the project root, create a development.env file to hold your environment variables needed for development. Similarly you can set up a production.env file for production. Each .env files should contain the following configuration variables that you need to define.

Variable Name	Default Value	Usage	Context
JWT_SECRET	<undefined>	Your Auth0 JWT secret private key to decrypt token sent by client to server and api.	All
FORGE_CREDENTIALS_CLIENT_SECRET	<undefined>	Your Forge Client Secret	All
FORGE_CREDENTIALS_CLIENT_ID	<undefined>	Your Forge Client ID	All
MONGODB		Your MongoDB connection uri with your password and cluster name	All

For MongoDB related configurations, please visit the Neo4j documentation on how to set up a database instance locally or on the cloud at https://docs.mongodb.com/manual

For Forge related configurations, please visit the Autodesk Forge Getting Started page for how to setup an Application with the Forge APIs at https://forge.autodesk.com/developer/getting-started

Running the project

• In Development: While still at the project root, start the server by running:

npm start

This starts the both Graphql and Express servers at 2 different ports.

Then, at the root of the project, start the client by running:

cd client
npm start

Open [http://localhost:3000] on your browser to view the project.

Todos

• Setup base GraphQL API
• Setup MongoDB
• Setup QR and Barcode Scanner on React Native as the Data Entry.
• Setup Site Diary entry with user based authentication for viewing confirmation and posting
• Setup Forge viewer for 3D model viewing
• Setup automatic colour change of model component based on installation status in MongoDB documents
• Setup Real-time colour change with Pusher and Node.js
• Setup Charts in React.js client by embedding SDK from Mongo Charts

⚠️Disclaimer: Please note that this is still an ongoing project and is under heavy development prone to constant breaking changes.

License

(Pending Confirmation) UNM and Gamuda Berhad