Skip to content

Commit

Permalink
Add setup in README
Browse files Browse the repository at this point in the history
  • Loading branch information
brenopolanski committed Nov 16, 2015
1 parent 06f1daa commit ea5d785
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
28 changes: 28 additions & 0 deletions src/main/resources/README.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# Meteorite Core UI

## Setup

In order to run it locally you'll need a basic server setup.

1. Install [NodeJS](http://nodejs.org/download/), if you don't have it yet.
2. Install local dependencies:

```sh
$ npm install
```
3. Run server:
```sh
$ npm start
```
4. Run tasks and serve:
```sh
$ gulp
```

## Tasks

- `gulp`: Initialize watch for changes and a server(localhost:8080/webpack-dev-server/index.html)
- `gulp bower-install`: Move dependencies to folder `dist/assets/`
- `gulp stylus`: Compile stylus files
- `gulp watch`: Call for watch files
- `gulp webpack`: Build files ReactJS
- `gulp webpack-dev-server`: Uses the webpack-dev-middleware to serve a webpack bundle
4 changes: 4 additions & 0 deletions src/main/resources/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
"bugs": {
"url": "http://jira.meteorite.bi"
},
"main": "server.js",
"scripts": {
"start": "node server.js"
},
"engines": {
"node": ">=0.10.x",
"npm": ">=1.3.x"
Expand Down

0 comments on commit ea5d785

Please sign in to comment.