Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added installation instructions for mac #93

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

added installation instructions for mac #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 32 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

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.
or comment on them. In a nutshell it can be looked at as a social blogging
platform for 3D models.

## Contribution Guidelines
TL;DR
We love contributions, if you want to contribute make sure you are on development branch to see the latest code. To prevent any duplicate work, please communicate if you are working on something.
We love contributions, if you want to contribute make sure you are on development branch to see the latest code. To prevent any duplicate work, please communicate if you are working on something.

The best (but not the only) way to contribute is
* Check if the issue you are trying to solve is already reported. (search the issue tracker)
Expand All @@ -20,7 +20,7 @@ The best (but not the only) way to contribute is
* Make sure when you make a Pull request, it is to the development branch.
* [optional] Assign a reviewer from one of the contributors, specially if you are new and have been talking to existing contributors.
* Never merge your own pull requests.
* Always check the "files changed" tab for any surprises.
* Always check the "files changed" tab for any surprises.
* Be polite and nice.


Expand Down Expand Up @@ -61,10 +61,33 @@ You will be asked for sudo access twice (for node and mongo)
* sudo apt-get install git
* git clone https://github.com/BRL-CAD/OGV-meteor

### Mac based distributions

* Install brew by following the instructions [here](https://docs.brew.sh/Installation)

* Install Nodejs

* brew install node

* Install mongoDB

* brew tap mongodb/brew
* brew install mongodb-community

* Install Meteor

* brew install curl
* curl https://install.meteor.com/ | sh

* Clone the OGV Repository

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

## Run
Move config.example.json to config.json and write admin password there.

To run app while developing use:
To run app while developing use:
```
npm run start
```
Expand All @@ -74,20 +97,19 @@ http://localhost:3000
```

## Lint
To run ESlint check run
To run ESlint check run
```
meteor npm run lint
meteor npm run lint
```

## Build and deploy
### Ubuntu and macOS
To build OGV run build script
To build OGV run build script
```
./scripts/build.sh
```
To start OGV run
To start OGV run
```
../OGV-build/bundle/start.sh
```
App will be running at http://localhost:3000