IIC2173-2015-2-Grupo2/GUI

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Newsify GUI

[![Build Status](https://travis-ci.org/IIC2173-2015-2-Grupo2/GUI.svg)](https://travis-ci.org/IIC2173-2015-2-Grupo2/GUI) [![Code Climate](https://codeclimate.com/github/IIC2173-2015-2-Grupo2/GUI/badges/gpa.svg)](https://codeclimate.com/github/IIC2173-2015-2-Grupo2/GUI) [![Codacy Badge](https://api.codacy.com/project/badge/502d48e9eef445468ec70b4f549fbb64)](https://www.codacy.com/app/lopezjuripatricio/GUI)

### Framework: AngularJS ([Styleguide](https://github.com/johnpapa/angular-styleguide))

### Development Setup

Make sure you have NodeJS 4.x.x and npm 3.3.4 installed.

Then, check if you have gulp installed. If you do not have it, run the following
command:

```sh
$ npm install --global gulp
```

And install all of the dependencies via

```sh
$ npm install
```

In order to start the *watch* tasks of gulp, just visit the application
directory and:

```sh
$ gulp
```

Finally, in order to start the local server, run the following in your terminal:

```sh
$ npm start
```

You should now be able to open your browser and visit `http://localhost:3000` to
begin using the application.

#### Docker

```sh
# Build
$ docker build --no-cache --rm --tag=newsify-gui .

# Run
$ docker run --publish 80:80 --rm --name=newsify-gui newsify-gui
```

##### Publish

Make sure to build first with `gulp build`. Then proceed tagging.

#### Notes:

* Since this application uses CDN for some of its scripts and stylesheets
(particularly AngularJS and Bootstrap), you must run the development environment
while connected to the internet.