README.md

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