Skip to content
Permalink
Browse files

doc:README and CONTRIBUTING updated

  • Loading branch information...
smpadhy committed Feb 5, 2018
1 parent e069e60 commit 6f5edae516e92b44e6be0f2d267ebae1550f43b2
Showing with 16 additions and 16 deletions.
  1. +14 −14 CONTRIBUTING.md
  2. +2 −2 README.md
@@ -37,6 +37,18 @@ vim app-config.js
npm start
```

#### Get clientId and secretKey from GitHub by registering this App
* Go to this [link](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/) and follow the steps.
* Use the following values:
* Application Name: brainverse
* Homepage URL: https://github.com/ReproNim/brainverse
* Authorization callback URL: http://127.0.0.1:3000/auth/github/callback

### To use BrainVerse as Web app
- Type '127.0.0.1:3000/' in your browser
- Login using your GitHub credentials
- To access any html page in eapp/modules/module-name/html in your browser, type '127.0.0.1:3000/module-name/html/HTMLFileName.html'
- The REST API for the app is in the eapp/routes directory

### Building for multiple platforms

@@ -52,20 +64,6 @@ docker run --rm \
"
```


#### Get clientId and secretKey from GitHub by registering this App
* Go to this [link](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/) and follow the steps.
* Use the following values:
* Application Name: brainverse
* Homepage URL: https://github.com/ReproNim/brainverse
* Authorization callback URL: http://127.0.0.1:3000/auth/github/callback

### To use BrainVerse as Web app
- Type '127.0.0.1:3000/' in your browser
- Login using your GitHub credentials
- To access any html page in eapp/modules/module-name/html in your browser, type '127.0.0.1:3000/module-name/html/HTMLFileName.html'
- The REST API for the app is in the eapp/routes directory

## Files organization
------------------

@@ -77,6 +75,8 @@ docker run --rm \
- Current modules that are being actively developed:
* `experiment-planner/`
* `nda-editor/`
* `instrument-editor`
* `data-collection`
* `term-search/`
* `audit-trail/`
- Deprecated modules (will be removed):
@@ -1,9 +1,9 @@
# brainverse

## Installation

The App for different OSes can be found in the [releases here](https://github.com/ReproNim/brainverse/releases)
### macOS
- Download the App (DMG file) from the [Dropbox link](https://www.dropbox.com/s/1ya58rsgm2kdz00/BrainVerse-0.0.1-security-fix.dmg?dl=0)
- Download the `.dmg` file
- Double click on the dmg file
- Drag the app icon to the Application folder, it will start installing
- To start the app, double click on the app icon in the Application folder

0 comments on commit 6f5edae

Please sign in to comment.
You can’t perform that action at this time.