brl-cad / ogv-meteor

Port of BRL-CAD's OGV to meteor

Online Geometry Viewer

Online Geometry Viewer is an online web application, where users can upload, view and share 3D CAD models. They can also host these models online, can like (love) or comment on them. In a nutshell it can be looked at as a social blogging platform for 3D models.

Table of Contents

• Installation
  • Using Install Script
  • Manual Installation
• Setup and Run
• Lint
• Build and Deploy
• Contribution

Installation

Clone this repo

git clone https://github.com/BRL-CAD/OGV-meteor.git

Debian and Ubuntu based Linux distributions

Using install script

./scripts/ubuntu_install.sh

You will be asked for sudo access twice (for node and mongo)

Manually

• Install Nodejs :

  • sudo apt-get install python-software-properties python g++ make
  • sudo add-apt-repository ppa:chris-lea/node.js
  • sudo apt-get update
  • sudo apt-get install nodejs

• Install mongoDB

  • sudo apt-get install mongodb

• Install Meteor

  • sudo apt-get install curl
  • curl https://install.meteor.com/ | sh

• Clone the OGV Repository

  • sudo apt-get install git
  • git clone https://github.com/BRL-CAD/OGV-meteor

Setup and Run

• You have to fill mail server configurations in the settings.json file

{
	"adminPassword": "password",
	"private": {},
	"public": {
		"smtp": {
			"username": "",
			"password": "",
			"server": "",
			"port": null
		},
		"general": {
			"sender": ""
		}
	}
}

Please note this step necessary. Otherwise, you'll not be able to login to the application.

• Move config.example.json to config.json and write admin password there.

• To run app while developing use:

npm run start

• Then open Browser and type in URL

http://localhost:3000

Lint

To run ESlint check run

meteor npm run lint 

Build and deploy

Ubuntu and macOS

To build OGV run build script

./scripts/build.sh

To start OGV run

../OGV-build/bundle/start.sh

App will be running at http://localhost:3000

Contribution

Please see CONTRIBUTION.md

ogv-meteor's Issues

Write tests

https://guide.meteor.com/testing.html

One of the major things required to get code quality of OGV up is by writing tests for it. As recommended in meteor's official guide we would like to use mocha and chai.

Outside click doesn't closes the menu dialog like notification and profile menu

404 page fix

The link to home page doesn't work on 404 page.

Make OGV Responsive

Needs to be done after #58

Make OGV work seamlessly on different screens.

Code linting

https://medium.com/netscape/git-hooks-with-husky-8b98f2556363

This is a two-step process

• Lint all of the existing code (JS and CSS)
• Make sure no non-standard code is added again using husky

Improve readme.

The current readme is arguable off-putting to new contributors. We need to do a better job at making the first impression.

Drop down menus do not close automatically

Drop down menu items in nav, stay open. They should close automatically when another drop-down menu is open.

Mediawiki oAuth

Currently, users need to have separate accounts on BRL-CAD site (mediawiki) and OGV. We would like to be able to add login with mediawiki to OGV

Apply dead code patch - GCI submission

Task link - https://codein.withgoogle.com/dashboard/task-instances/6400681577545728/
by Amanda Han
Provided as a submission in GCI'2016

Add labels to models

Add labels, to models and allow users to search news feed by models.

Data not found error

When you run meteor for first time you get an error that says
Couldn't find a template named "dataNotFound" or "dataNotFound". Are you sure you defined it?

This happens when brl-cad is not installed on server. So we need two things

• We need the error to say that probably BRL-CAD was not installed
• We need a dataNotfFound template that shows a obj version of any of our models.
• [Optional] We need to change the default model to something more fancy ;)

Auto Position depending upon object's width/height

Idea is to get the visible width/height of the obj file/files in the scene and make sure they are in center and zoomed enough.

This might help
https://discourse.threejs.org/t/functions-to-calculate-the-visible-width-height-at-a-given-z-depth-from-a-perspective-camera/269

OGV Mediawiki Plugin

Idea is to create a mediawiki plugin, that asks wiki admin to enter the OGV server details and allows users to

• search for a public model from OGV server
• Upload modal to OGV (depends on issue #59 )
• Embed into mediawiki page.
• Allow mediawiki plugin to be used without server (OBJ uploads)

Upload progress

Show an upload progress bar when uploading a model.

Typography fixes

There are bunch of typography design errors in OGV that needs to be solved

Todo coming soon!

Bring custom coloring back

OGV used to have custom coloring panel which was removed when we chose to add colors directly from .g file. However, as we also allow upload of single obj files it's worth allowing the user to change colors of different parts if he/she wants.

No error shown if upload fails

If due to some reason upload of the model fails, there's no error indicating that it has failed.

Readme not showing installation process for Arch and windows!

Only the installation process for Debian and Debian based Ubuntu are there. So, I consider having the installation process for Arch as well.

Also there are many programmers and designers using windows, so, I think readme should also include for windows as well!

Edit link is not working

The edit link currently goes to 404 page.

Love button not working when clicked show error `Post id is required`

CSS code improvement [Code Quality]

All of the current CSS code is one file. Divide it into multiple files and improve the code quality.

Discus possible porting to scss.

Port three.js to its latest version.

Remove the CFS dependency

Collection FS has been depcreciated (and recently depreciation label was removed). It would be better to move away from Collection FS use npm packages directly to upload models. (Can s3 be used?)

Meteor admin user creation

If you run meteor without properly writing config.json. Default admin user is created without any password.

We would also like the default admin password be generated randomly and shown in server console rather than your_password_here

Uploader is not working for g files

With the final changes done, it seems uploader has stopped working for g files completely. This task contains

• Figure out the issue
• Consult with the previous dev on the patched g-obj converter.
• Get the upload working

Update meteor to the latest version

Currently, we are using an old-ish version of meteor. We would like to move it to the latest version (1.6.1).

Dedicated buttons to change camera angle

OGV supports changing the views of the canvas while previewing the model using keyboard shortcuts. However, if there could be dedicated buttons on the left side pane (where we set the axis line toggle, custom background, etc) could be helpful. The main idea is to provide a good user experience with buttons to switch the camera angle with buttons as well.

3D Object Database Persistence w/CORS

Images/Models not loading from database in OGV.

This is a big issue for loading 3D Models, and does not allow for the 3D object geometry viewing to be consistent or persistent.

Fixing this database persistence issue with firebase and a backend revamp of the mongoDB database.

Email server error

Don't allow the creation of user account until the admin has set email server.

A better way is to create a set of settings called required settings and signup/login nothing should even begin before those required settings are done.