diff --git a/README.md b/README.md index 8297a02..595708d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ # Marble Initiative This is the main repository for the Marble Initiative project. -More information about it could be found in the [main website] (http://marble.miguelfc.com/), and more technical information in + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +The platform is able to extract tweets from [Twitter](https://twitter.com), using both the Search (history) and the Streaming (real-time) API, process the tweets extracted and extract their polarity values, and visualize the results using charts and reports. + +More information about it could be found in the [main website](http://marble.miguelfc.com/), and more technical information in the [Wiki pages](https://github.com/miguelfc/marble/wiki) of this repository. ## Usage @@ -14,11 +19,9 @@ All modules for this project are published in docker hub for free (as in speech) - [miguelfc/marble-processor-stanford](https://hub.docker.com/r/miguelfc/marble-processor-stanford/) - [miguelfc/marble-processor-nltk](https://hub.docker.com/r/miguelfc/marble-processor-nltk/) - [miguelfc/marble-processor-sklearn](https://hub.docker.com/r/miguelfc/marble-processor-sklearn/) -- [miguelfc/marble-processor-python2](https://hub.docker.com/r/miguelfc/marble-processor-python2/) -- [miguelfc/marble-processor-python3](https://hub.docker.com/r/miguelfc/marble-processor-python3/) - [miguelfc/marble-plotter-simple](https://hub.docker.com/r/miguelfc/marble-plotter-simple/) -*(The python2 and python3 processor images are just the base structure for future python processors, they don't perform any processing at the moment)* +*(The python2 and python3 processor modules found in the project are just the base structure for future python processors, they don't perform any processing at the moment)* A `docker-compose.yml` configuration file is available for you to use directly on a docker-capable server. You will only need access to internet to start using marble (you don't even need a database, as it will be provided by docker too!). @@ -47,8 +50,8 @@ Then, just go to the `docker` folder in a terminal, and execute the following co Docker will retrieve the latest version of all module images, and start the marble service. You will have two services available: -- The marble portal at port `8080`. -- The eureka registry at port `1111`. +- The marble portal at port [`8080`](http://localhost:8080) +- The eureka registry at port [`1111`](http://localhost:1111) If you want to keep an eye on the logs of one or all the modules running, you can execute the `logs` command of `docker-compose`: diff --git a/docker/core-config/application.yml b/docker/core-config/application.yml index 8f01d2e..2884a8c 100644 --- a/docker/core-config/application.yml +++ b/docker/core-config/application.yml @@ -1,10 +1,10 @@ access: admin: - username: '' - password: '' + username: 'youshouldchangethis' + password: 'yesyoudo' oper: - username: '' - password: '' + username: 'pleasechangethis' + password: 'prettyplease' guest: - username: '' - password: '' + username: 'youmustchangethisnow' + password: 'changeitnowplease' diff --git a/docs/assets/images/favicon.ico b/docs/assets/images/favicon.ico index 0f7590a..cd66697 100644 Binary files a/docs/assets/images/favicon.ico and b/docs/assets/images/favicon.ico differ diff --git a/docs/assets/images/favicon.png b/docs/assets/images/favicon.png new file mode 100644 index 0000000..ca4b2bc Binary files /dev/null and b/docs/assets/images/favicon.png differ diff --git a/docs/index.html b/docs/index.html index 4397c38..d553b1e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ Marble Initiative - + @@ -122,15 +122,14 @@

Is it ready?

I want to try it anyway. Can I?

-

Sure!. You will need a Java EE application Server, a MongoDB instance for the data, and a PostgreSQL database as the hibernate repository. We use Wildfly 8/Java 7 in our development environments, but any modern application server should work (you will need to modify some configuration files, though).

+

Sure!. You will need a server with internet connection and docker installed, and everything else will be taken care of. Be sure to follow the instructions on our github site, and you will get a MongoDB, an Eureka registry and the full marble platform using a single command from the shell.

Where is the documentation?

-

Well, there is none yet. Hopefully, once we approach the release phase, we will have stabilized the platform (at least to some degree) and we will work on - the documentation. +

You can find the documentation in the project's Wiki, and in the main README file of the project.

@@ -149,17 +148,9 @@

How is this project licensed?

* I'm trying to access the demo but it seems down.

-

Yes, it could happen. It could be restarting or struggling for resources. Our demo is being kindly hosted by heroku, in a free dyno with limited resources. So, in terms of memory and CPU it will be on the limit for most operations. If you find it down, give it five minutes to recover (sometimes it is just processing stuff on the background) as it usually takes that time to go up. If it doesn't, drop me a line.

- - - diff --git a/marble-core/pom.xml b/marble-core/pom.xml index 4df3ed9..1616b91 100644 --- a/marble-core/pom.xml +++ b/marble-core/pom.xml @@ -5,7 +5,7 @@ org.marble marble-core - 1.0.0-SNAPSHOT + 1.0.0-RELEASE 1.8 @@ -17,7 +17,7 @@ org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -54,7 +54,7 @@ org.marble marble-model - 1.0.0-SNAPSHOT + 1.0.0-RELEASE @@ -162,6 +162,7 @@ + app ${basedir}/src/main/resources @@ -242,6 +243,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-core/src/main/docker/Dockerfile b/marble-core/src/main/docker/Dockerfile index 2febf6e..28fce89 100644 --- a/marble-core/src/main/docker/Dockerfile +++ b/marble-core/src/main/docker/Dockerfile @@ -1,6 +1,5 @@ FROM java:8 VOLUME /tmp -ADD marble-core-1.0.0-SNAPSHOT.jar app.jar +ADD app.jar app.jar RUN bash -c 'touch /app.jar' -EXPOSE 1111 CMD cd config & java -jar ../app.jar diff --git a/marble-core/src/main/docker/README-short.txt b/marble-core/src/main/docker/README-short.txt new file mode 100644 index 0000000..3c8216c --- /dev/null +++ b/marble-core/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Main module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-core/src/main/docker/README.md b/marble-core/src/main/docker/README.md new file mode 100644 index 0000000..decc24d --- /dev/null +++ b/marble-core/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-core, represents the main module, providing the backend and frontend capabilities to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-model/pom.xml b/marble-model/pom.xml index dd8f491..b3e2af9 100644 --- a/marble-model/pom.xml +++ b/marble-model/pom.xml @@ -3,7 +3,7 @@ 4.0.0 org.marble marble-model - 1.0.0-SNAPSHOT + 1.0.0-RELEASE jar diff --git a/marble-plotter-simple/pom.xml b/marble-plotter-simple/pom.xml index 4f76527..05284c3 100644 --- a/marble-plotter-simple/pom.xml +++ b/marble-plotter-simple/pom.xml @@ -3,13 +3,13 @@ 4.0.0 org.marble marble-plotter-simple - 1.0.0-SNAPSHOT + 1.0.0-RELEASE jar org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -22,7 +22,7 @@ org.marble marble-model - 1.0.0-SNAPSHOT + 1.0.0-RELEASE @@ -67,6 +67,7 @@ + app org.springframework.boot @@ -93,6 +94,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-plotter-simple/src/main/docker/Dockerfile b/marble-plotter-simple/src/main/docker/Dockerfile index d405dbb..619efc4 100644 --- a/marble-plotter-simple/src/main/docker/Dockerfile +++ b/marble-plotter-simple/src/main/docker/Dockerfile @@ -1,6 +1,5 @@ FROM java:8 VOLUME /tmp -ADD marble-plotter-simple-1.0.0-SNAPSHOT.jar app.jar +ADD app.jar app.jar RUN bash -c 'touch /app.jar' -EXPOSE 1111 ENTRYPOINT ["java","-jar","/app.jar"] diff --git a/marble-plotter-simple/src/main/docker/README-short.txt b/marble-plotter-simple/src/main/docker/README-short.txt new file mode 100644 index 0000000..bbe880e --- /dev/null +++ b/marble-plotter-simple/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Plotter module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-plotter-simple/src/main/docker/README.md b/marble-plotter-simple/src/main/docker/README.md new file mode 100644 index 0000000..e0fd1be --- /dev/null +++ b/marble-plotter-simple/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-plotter-simple, is a plotter module, providing charts and report to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-preprocessor-simple/pom.xml b/marble-preprocessor-simple/pom.xml index 56a74e1..cb3fb66 100644 --- a/marble-preprocessor-simple/pom.xml +++ b/marble-preprocessor-simple/pom.xml @@ -3,13 +3,13 @@ 4.0.0 org.marble marble-preprocessor-simple - 1.0.0-SNAPSHOT + 1.0.0-RELEASE jar org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -22,7 +22,7 @@ org.marble marble-model - 1.0.0-SNAPSHOT + 1.0.0-RELEASE @@ -62,6 +62,7 @@ + app org.springframework.boot @@ -88,6 +89,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-preprocessor-simple/src/main/docker/Dockerfile b/marble-preprocessor-simple/src/main/docker/Dockerfile index 8f42055..619efc4 100644 --- a/marble-preprocessor-simple/src/main/docker/Dockerfile +++ b/marble-preprocessor-simple/src/main/docker/Dockerfile @@ -1,6 +1,5 @@ FROM java:8 VOLUME /tmp -ADD marble-preprocessor-simple-1.0.0-SNAPSHOT.jar app.jar +ADD app.jar app.jar RUN bash -c 'touch /app.jar' -EXPOSE 1111 ENTRYPOINT ["java","-jar","/app.jar"] diff --git a/marble-preprocessor-simple/src/main/docker/README-short.txt b/marble-preprocessor-simple/src/main/docker/README-short.txt new file mode 100644 index 0000000..a8d461d --- /dev/null +++ b/marble-preprocessor-simple/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Preprocessor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-preprocessor-simple/src/main/docker/README.md b/marble-preprocessor-simple/src/main/docker/README.md new file mode 100644 index 0000000..43e1e23 --- /dev/null +++ b/marble-preprocessor-simple/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-preprocessor-simple, is a preprocessor module, providing cleaning methods to be used along processor modules. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-processor-nltk/pom.xml b/marble-processor-nltk/pom.xml index 1a3ab41..f23d2e9 100644 --- a/marble-processor-nltk/pom.xml +++ b/marble-processor-nltk/pom.xml @@ -4,14 +4,14 @@ 4.0.0 org.marble marble-processor-nltk - 1.0.0-SNAPSHOT + 1.0.0-RELEASE 1.8 org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml diff --git a/marble-processor-nltk/src/main/docker/README-short.txt b/marble-processor-nltk/src/main/docker/README-short.txt new file mode 100644 index 0000000..281f038 --- /dev/null +++ b/marble-processor-nltk/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Processor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-processor-nltk/src/main/docker/README.md b/marble-processor-nltk/src/main/docker/README.md new file mode 100644 index 0000000..8cbe463 --- /dev/null +++ b/marble-processor-nltk/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-processor-nltk, is a processor module, providing text processing methods to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-processor-python2/pom.xml b/marble-processor-python2/pom.xml index b351472..0be0183 100644 --- a/marble-processor-python2/pom.xml +++ b/marble-processor-python2/pom.xml @@ -12,7 +12,7 @@ org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -32,6 +32,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-processor-python2/src/main/docker/README-short.txt b/marble-processor-python2/src/main/docker/README-short.txt new file mode 100644 index 0000000..281f038 --- /dev/null +++ b/marble-processor-python2/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Processor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-processor-python2/src/main/docker/README.md b/marble-processor-python2/src/main/docker/README.md new file mode 100644 index 0000000..4952587 --- /dev/null +++ b/marble-processor-python2/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-processor-, is a processor module, providing text processing methods to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-processor-python3/pom.xml b/marble-processor-python3/pom.xml index 8ec8468..2a5f6d7 100644 --- a/marble-processor-python3/pom.xml +++ b/marble-processor-python3/pom.xml @@ -12,7 +12,7 @@ org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -32,6 +32,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-processor-python3/src/main/docker/README-short.txt b/marble-processor-python3/src/main/docker/README-short.txt new file mode 100644 index 0000000..281f038 --- /dev/null +++ b/marble-processor-python3/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Processor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-processor-python3/src/main/docker/README.md b/marble-processor-python3/src/main/docker/README.md new file mode 100644 index 0000000..4952587 --- /dev/null +++ b/marble-processor-python3/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-processor-, is a processor module, providing text processing methods to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-processor-simple/pom.xml b/marble-processor-simple/pom.xml index 20f9f30..a3874f0 100644 --- a/marble-processor-simple/pom.xml +++ b/marble-processor-simple/pom.xml @@ -3,13 +3,13 @@ 4.0.0 org.marble marble-processor-simple - 1.0.0-SNAPSHOT + 1.0.0-RELEASE jar org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -22,7 +22,7 @@ org.marble marble-model - 1.0.0-SNAPSHOT + 1.0.0-RELEASE @@ -73,6 +73,7 @@ + app org.springframework.boot @@ -99,6 +100,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-processor-simple/src/main/docker/Dockerfile b/marble-processor-simple/src/main/docker/Dockerfile index 59dfe77..619efc4 100644 --- a/marble-processor-simple/src/main/docker/Dockerfile +++ b/marble-processor-simple/src/main/docker/Dockerfile @@ -1,6 +1,5 @@ FROM java:8 VOLUME /tmp -ADD marble-processor-simple-1.0.0-SNAPSHOT.jar app.jar +ADD app.jar app.jar RUN bash -c 'touch /app.jar' -EXPOSE 1111 ENTRYPOINT ["java","-jar","/app.jar"] diff --git a/marble-processor-simple/src/main/docker/README-short.txt b/marble-processor-simple/src/main/docker/README-short.txt new file mode 100644 index 0000000..281f038 --- /dev/null +++ b/marble-processor-simple/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Processor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-processor-simple/src/main/docker/README.md b/marble-processor-simple/src/main/docker/README.md new file mode 100644 index 0000000..627537b --- /dev/null +++ b/marble-processor-simple/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-processor-simple, is a processor module, providing text processing methods to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-processor-sklearn/pom.xml b/marble-processor-sklearn/pom.xml index 43b3ba1..b66aadf 100644 --- a/marble-processor-sklearn/pom.xml +++ b/marble-processor-sklearn/pom.xml @@ -4,14 +4,14 @@ 4.0.0 org.marble marble-processor-sklearn - 1.0.0-SNAPSHOT + 1.0.0-RELEASE 1.8 org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml diff --git a/marble-processor-sklearn/src/main/docker/README-short.txt b/marble-processor-sklearn/src/main/docker/README-short.txt new file mode 100644 index 0000000..281f038 --- /dev/null +++ b/marble-processor-sklearn/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Processor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-processor-sklearn/src/main/docker/README.md b/marble-processor-sklearn/src/main/docker/README.md new file mode 100644 index 0000000..b48a44d --- /dev/null +++ b/marble-processor-sklearn/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-processor-sklearn, is a processor module, providing text processing methods to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-processor-stanford/pom.xml b/marble-processor-stanford/pom.xml index 7a3a69c..cdb7661 100644 --- a/marble-processor-stanford/pom.xml +++ b/marble-processor-stanford/pom.xml @@ -3,13 +3,13 @@ 4.0.0 org.marble marble-processor-stanford - 1.0.0-SNAPSHOT + 1.0.0-RELEASE jar org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -22,7 +22,7 @@ org.marble marble-model - 1.0.0-SNAPSHOT + 1.0.0-RELEASE @@ -85,6 +85,7 @@ + app org.springframework.boot @@ -111,6 +112,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-processor-stanford/src/main/docker/Dockerfile b/marble-processor-stanford/src/main/docker/Dockerfile index 771ff52..619efc4 100644 --- a/marble-processor-stanford/src/main/docker/Dockerfile +++ b/marble-processor-stanford/src/main/docker/Dockerfile @@ -1,6 +1,5 @@ FROM java:8 VOLUME /tmp -ADD marble-processor-stanford-1.0.0-SNAPSHOT.jar app.jar +ADD app.jar app.jar RUN bash -c 'touch /app.jar' -EXPOSE 1111 ENTRYPOINT ["java","-jar","/app.jar"] diff --git a/marble-processor-stanford/src/main/docker/README-short.txt b/marble-processor-stanford/src/main/docker/README-short.txt new file mode 100644 index 0000000..281f038 --- /dev/null +++ b/marble-processor-stanford/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Processor module for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-processor-stanford/src/main/docker/README.md b/marble-processor-stanford/src/main/docker/README.md new file mode 100644 index 0000000..c40f464 --- /dev/null +++ b/marble-processor-stanford/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-processor-stanford, is a processor module, providing text processing methods to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/marble-registry/pom.xml b/marble-registry/pom.xml index c520fd9..8b0687e 100644 --- a/marble-registry/pom.xml +++ b/marble-registry/pom.xml @@ -3,13 +3,13 @@ 4.0.0 org.marble marble-registry - 1.0.0-SNAPSHOT + 1.0.0-RELEASE jar org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE ../pom.xml @@ -45,6 +45,7 @@ + app org.springframework.boot @@ -71,6 +72,10 @@ ${docker.image.prefix}/${project.artifactId} + + ${project.version} + latest + ${project.basedir}/src/main/docker diff --git a/marble-registry/src/main/docker/Dockerfile b/marble-registry/src/main/docker/Dockerfile index 3c2a5d2..619efc4 100644 --- a/marble-registry/src/main/docker/Dockerfile +++ b/marble-registry/src/main/docker/Dockerfile @@ -1,6 +1,5 @@ FROM java:8 VOLUME /tmp -ADD marble-registry-1.0.0-SNAPSHOT.jar app.jar +ADD app.jar app.jar RUN bash -c 'touch /app.jar' -EXPOSE 1111 ENTRYPOINT ["java","-jar","/app.jar"] diff --git a/marble-registry/src/main/docker/README-short.txt b/marble-registry/src/main/docker/README-short.txt new file mode 100644 index 0000000..901333b --- /dev/null +++ b/marble-registry/src/main/docker/README-short.txt @@ -0,0 +1 @@ +Service registry for Marble, an opinion mining platform, modular and open sourced. diff --git a/marble-registry/src/main/docker/README.md b/marble-registry/src/main/docker/README.md new file mode 100644 index 0000000..f77ca10 --- /dev/null +++ b/marble-registry/src/main/docker/README.md @@ -0,0 +1,39 @@ +# Supported tags and respective `Dockerfile` links + +- [`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile) + +# What is Marble? + +[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo. + +Marble is composed of several modules. This one, marble-registry, is a processor module, providing a service registry (based on eureka) to the system. + +All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble). + +# How to use this image + +As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use. + +The required services are mongodb, registry and core, so you can launch them using the up subcommand: + +```console +$ docker-compose up mongodb registry core +``` + +If you want to launch all the provided modules, then you can just use the up subcommand without arguments: + +```console +$ docker-compose up +``` + +Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser. + +For more specific details please check the [Github project](https://github.com/miguelfc/marble). + +# Issues + +If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project. + +# Contributing + +You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. \ No newline at end of file diff --git a/pom.xml b/pom.xml index d7203e5..e59f496 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.marble marble - 1.0.0-SNAPSHOT + 1.0.0-RELEASE pom