Skip to content

README.md

Latest commit

 

History

History
111 lines (102 loc) · 5.91 KB

README.md

File metadata and controls

111 lines (102 loc) · 5.91 KB

BIMFACE-Starter

A starter for BIMFACE development which has both client and server. The client users can upload / translate files and save / load business data (like tags) using the program.

Technology Stack

  • BIM
    • BIMFACE
  • Server
    • Typescript, koa2, TypeORM, JWT
  • Client
    • Javascript (ES6), Vue2, Vuex, Element-UI, Webpack

How to use

Preparation

  • Prepare BIMFACE AppKey and AppSecret
    • Register the BIMFACE account
    • Get AppKey and AppSecret from BIMFACE Console
  • Prepare Database. Basically, you can use any database, and mysql is the database used in the starter.
    • Install mysql
    • Log in the mysql with your account.
      • mysql -u <your_db_account_name> -p, e.g., mysql -u foo -p
    • Create starter database. 'utf8' is needed for characters like Chinese.
      • CREATE DATABASE bimface_starter CHARACTER SET='utf8';
  • Prepare Node.js environment

Start Server

  • Go to server folder in the terminal.
  • Install dependencies.
    • npm install
  • Set up BIMFACE application credentials by setting environment variables. Mac/Linux terminal uses export <var_name>=<var_value> and Windows terminal uses set <var_name>=<var_value>. The examples below use Mac style.
    • Set BIMFACE app key. export BIMFACE_APP_KEY="<your_key>", e.g., export BIMFACE_APP_KEY="bar"
    • Set BIMFACE app secret. export BIMFACE_APP_SECRET="<your_secret>"
  • Set up database connection information by modifying server/ormconfig.json. There are two option sets in the file, and we just need to modify the one with name "default".
    • Set database type. "type": "mysql"
    • Set database host. "host": "localhost"
    • Set database port. "port": "3306"
    • Set database username. "username": "<your_name>", e.g., "username": "sonic"
    • Set database user password. "password": "<your_password>"
    • Set database name. "database": "bimface_starter"

You can also do this by setting envionment variables. See more on Environment Variables section below.

Start Client

  • Go to client folder.
  • Install dependencies.
    • npm install
  • Run client. The default client address is http://localhost:8080. The port will be different if it's occupied by other program.
    • npm run dev

Use the program

  • Navigate to http://localhost:8080 in your browser.
  • Sign up and sign in.
  • Go to File Management from top menu Data Management.
  • Upload your model files (e.g., rvt) or CAD files (e.g., dwg) using the plus button. If you don't have any, download the sample files from BIMFACE Developer Guide. The uploaded files will be placed in the Untranslated Files category.
  • Check the files and translate them using the flying plane button. Wait for a moment for the data processing and the translated files will be placed in the Translated Files category.
  • Click on the file names to view them. And you can do extra operations with 3D models, like adding some tags using the menues at the top.

How does it work

The server uses BIMFACE service to upload / translate / delete files and stores business data to the database you created.

Environment Variables

  • Server
    • NODE_ENV, the switch for production and developement variables. Values could be 'production' or 'development' and the latter is the default.
    • PORT, the port of the server, default is 3000.
    • BIMFACE_APP_KEY, the app key of BIMFACE.
    • BIMFACE_APP_SECRET, the app secret of BIMFACE.
    • JWT_SECRET, the secret of JWT authentication. YOU SHOULD USE YOUR OWN SECRET instead of using the default !you-need-to-change-this!
    • JWT_EXPIRE_IN, the JWT token expire time, default is 24h which means 24 hours.
    • DB_TYPE, type name of the database, default is mysql.
    • DB_HOST, the host of the database, default is localhost.
    • DB_PORT, the port of the database, default is 3306
    • DB_USER_NAME, the user name of the database.
    • DB_PASSWORD, the user password of the database.
    • DB_DATABASE, the database name, default is bimface_starter

If you want to use the same settings in your team, or wish to set up variables in code, input the configs in the src/configs/GlobalConfigs.ts.

The system variables overwrite the settings in GloabalConfigs.ts

  • Client
    • NODE_ENV, the switch for production and developement variables. Values could be 'production' or 'development' and the latter is the default.

Set the host address for producton and development at src/store/modules/configs.js

Licensing

MIT.

FAQ

  • How to save / load / extend the business data?
    • Go to client/src/components/FileViewer.ts, check save() and load() methods. Each file has a custom data for business data storage, and the size is 16 MB.
  • How to create database tables in production?
    • npm run typeorm schema:sync
  • How to create an admin user?
    • Make sure the connection information is set properly in ormconfig.json.
    • Go to server/src/migration/1600160859707-CreateAdmin.js.
    • Modify the user credentials.
    • npm run typeorm migration:run
  • How to deploy the output in production?
    • For server
      • npm run build
      • npm install -g pm2
      • npm run prd or place the outputs of dist/ to your server and run with the www.js file.
    • For client
      • npm run build
      • Place the outputs of dist/ to your static server.
        • If the static server is nginx, you may need to add contents below to your nginx.conf 
          location / {
    try_files $uri $uri/ <your_dist_folder_name>/$uri /index.html @bsServer;
}

location @bsServer {
     proxy_pass <your_production_host_server_address>; // e.g., http://10.10.10.10:3000
}