<commit_before># NetWatcher

NetWatcher is a web-based interface to manage network traffic capturer FPGAs.

Version
----
0.1 - Design ([changelog](changelog.md))


License
----

[MIT](LICENSE)


Tech
----

NetWatcher uses a number of open source projects to work properly:

* [Twitter Bootstrap](http://twitter.github.com/bootstrap/index.html) - great UI boilerplate for modern web apps
    * [Bootswatch](http://bootswatch.com/) - themes for Bootstrap
    * [Bootstrap Growl](https://github.com/ifightcrime/bootstrap-growl) - notifications
* [io.js](https://iojs.org) - evented I/O for the backend server
* [jQuery](https://jquery.com) - JavaScript library
* [Composer](https://getcomposer.org) - PHP library for external dependencies
* [phpDocumentor](https://www.phpdoc.org) - documentation generator

Installation
----
* Download the repository and extract it. Change directory to the repository folder.
* Install packages and active them
```sh
$ ./scripts/build.sh --install
```

* Check Gettext
    * phpinfo(): GetText Support enabled
    * Status page

* Install libraries and dependencies
```sh
$ ./scripts/upgrade.sh
```

* Translations (implementing more languages)
    * Edit ./locale/ files with a PO file editor, ex: [POEdit](https://poedit.net)

Other Scripts
----

* Generate Documentation
```sh
$ ./scripts/gen_doc.sh
```

* Check PHP files syntax
```sh
$ ./scripts/check_php.sh
```


* Fix permissions
```sh
$ ./scripts/do_chmod.sh
```

Tools for Programming
----
[Trello Board](https://trello.com/b/73kOdUNM/tfg)

[Eclipse - PHP](http://www.eclipse.org/pdt/)

Useful Commands
----
Start/Stop Apache
```sh
$ sudo service apache2 stop
$ sudo service apache2 start
```
<commit_msg>Updated sections, table of contents<commit_after># NetWatcher

NetWatcher is a web-based interface to manage network traffic capturer FPGAs, developed as an End-of-Degree Project in collaboration with the [High Performance Computing and Networking](http://www.hpcn.es/) research group. The project has been released for educational purposes, since no new features are going to be added.

## Table of contents

- [Version](#version)
- [License](#version)
- [Tech](#tech)
- [Installation](#installation)
- [Documentation](#documentation)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Other Scripts](#other-scripts)


Version
----
0.1 - Design Prototype ([changelog](changelog.md))


License
----
Code released under the [MIT license](LICENSE). Docs released under Creative Commons.

Tech
----

NetWatcher uses a number of open source projects to work properly:

* [Twitter Bootstrap](http://twitter.github.com/bootstrap/index.html) - great UI boilerplate for modern web apps
    * [Bootswatch](http://bootswatch.com/) - themes for Bootstrap
    * [Bootstrap Growl](https://github.com/ifightcrime/bootstrap-growl) - notifications
* [io.js](https://iojs.org) - evented I/O for the backend server
* [jQuery](https://jquery.com) - JavaScript library
* [Composer](https://getcomposer.org) - PHP library for external dependencies

Installation
----
* Download the repository and extract it. Change directory to the repository folder.
* Install required packages
```sh
$ ./scripts/install_dependencies.sh
```

* Translations (implementing more languages)
    * Edit ./locale/ files with a PO file editor, ex: [POEdit](https://poedit.net)

Documentation
----
NetWatcher's documentation is built with [phpDocumentor](https://www.phpdoc.org) and included in the [docs/api/](docs/api/) folder as a webpage. Further documentation about the project architecture and additional reading can be found in the [docs/](docs/) folder too.

Bugs and feature requests
----
Although no new features are going to be added, if you have found a bug and you have a *tested* fix for it, you can submit a pull request.

Other Scripts
----

* Install required packages
```sh
$ ./scripts/install_dependencies.sh
```

* Install/Upgrade libraries and dependencies
```sh
$ ./scripts/upgrade.sh
```

* Generate Documentation
```sh
$ ./scripts/gen_doc.sh
```

* Update libraries and dependencies
```sh
$ ./lib/vendor/composer.phar update
```

* Check PHP files syntax
```sh
$ ./scripts/check_php.sh
```

* Fix permissions
```sh
$ ./scripts/do_chmod.sh
```

* Check Gettext
    * phpinfo(): GetText Support enabled
    * Status page

{'fraction_non_alphanumeric': 0.13376683697166744, 'fraction_numerical': 0.0018578727357176034, 'mean_word_length': 4.025670945157526, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 13, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '36316', 'n_tokens_mistral': 1325, 'n_tokens_neox': 1243, 'n_words': 416}