https://github.com/jonathas/roman-numerals

A web based application that converts numbers to roman numerals and vice versa
https://github.com/jonathas/roman-numerals

angularjs docker istanbul math mocha nginx nodejs roman-numerals

Last synced: 18 days ago
JSON representation

A web based application that converts numbers to roman numerals and vice versa

• Host: GitHub
• URL: https://github.com/jonathas/roman-numerals
• Owner: jonathas
• License: mit
• Created: 2017-11-22T07:29:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-29T07:54:27.000Z (about 7 years ago)
• Last Synced: 2024-11-16T06:28:26.887Z (3 months ago)
• Topics: angularjs, docker, istanbul, math, mocha, nginx, nodejs, roman-numerals
• Language: JavaScript
• Homepage:
• Size: 106 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Roman Numerals

## A web based application that converts numbers to roman numerals and vice versa

[![Build Status](https://travis-ci.org/jonathas/roman-numerals.svg?branch=master)](https://travis-ci.org/jonathas/roman-numerals) [![Coverage Status](https://coveralls.io/repos/github/jonathas/roman-numerals/badge.svg?branch=master)](https://coveralls.io/github/jonathas/roman-numerals?branch=master)

![alt text](https://github.com/jonathas/roman-numerals/blob/master/roman_numerals.jpg "Roman Numerals Clock")

### Technologies used

Node.js, Express, AngularJS, pm2, Docker, Nginx, apiDoc, mocha, istanbul.

### Dependencies

- Node.js 7

- yarn

- Docker

- docker-compose

### Before anything

Install the packages by entering the api directory and running:

```bash

yarn

```

### Testing the API and checking the code coverage

In order to run the tests, enter the api directory and run:

```bash

yarn test

```

After that, you can open api/coverage/lcov-report/index.html on your browser to check the code coverage result.

### Generating the documentation for the endpoints

In order to generate the HTML with the documentation, enter the api directory and run:

```bash

yarn docs

```

After that, it will be available inside docs/apidoc

### Developing

For developing new functionalities, you can use nodemon, pm2 or the pm2 docker image for development. If you choose the docker image, then enter the infra directory and run:

```bash

docker-compose -f docker-dev.yml up

```

This will start the Nginx and pm2 containers. This pm2 container is configured for reloading the code every time it is modified.

### Deploying

In order to run it in production, instead of running the docker-dev.yml file, you can run the docker-compose.yml file:

```bash

docker-compose up

```

### Running the web interface

After starting the API following the previous steps, just open http://localhost on your browser.

## Further improvements

- Minification

- E2E and unit tests