Skip to content

Commit

Permalink
Adding readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
constantinius committed May 9, 2018
1 parent a41f259 commit 23f7d74
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# COG-Explorer

This is the repository for the COG-Explorer app.

## Setup

To set everything up run:

npm install

## Building

To build the application bundle run:

npm run build

The bundle is now available in the `dist` directory.

## Deployment

To deploy the app on github pages first commit the built bundle:

git commit dist/ -m "Updating bundle."

Now run this command to deploy on github pages:

npm run deploy

Note: the `gh-pages` branch must be present and you have to have write access to your remote.

0 comments on commit 23f7d74

Please sign in to comment.