HTTP API & backend for SERP Connect
Java
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
dep/neo4j
docs
src
txdb
.gitignore
CONTRIBUTING.md
CONTRIBUTORS
LICENSE
README.md
circle.yml
pom.xml
requirements.txt

README.md

SERP Connect

CircleCI

SERP Connect is a project that connects research results in software engineering with challenges the industry have identified using a shared taxonomy. In addition to search & match capabilities this web tool also features collections, possibility to experiment with taxonomy extensions and powerful visualizations which aid presentations and provide overview.

This repository contains the server (backend) of the project. It also contains the documentation hosted on read-the-docs.

Get Involved

  • Contributing: Pull requests are welcome!
    • Read CONTRIBUTING.md
    • Submit github issues for features, bugs or documentation problems
  • Discuss: Talk to us and others over at slack

Installation

A full explanation on installing connect and the dependencies is included in the getting-started documentation.

git clone https://github.com/emenlu/connect
cd connect
mvn compile exec:java -Dpippo.mode=DEV

Requirements

  • Apache maven (mvn) link
  • Java SDK (1.8+)
  • neo4j database (2.3.X)

Misc

Default port is 8080, can be changed in the configuration file (application.properties).

The config file is located: src/main/resources/conf/application.properties

Email templates are located: src/main/resources/conf/messages_en.properties

We are using some maven plugins(?) to handle testing, execution and packaging:

  • to run (dev,default=prod): mvn compile exec:java -Dpippo.mode=dev
  • see debug level output: -Dorg.slf4j.simpleLogger.defaultLogLevel=trace
  • to clean: mvn clean (do this when in doubt)
  • to build: mvn package
  • to test: mvn verify

Deploying (production mode):

  • mvn package --> target/connect-X.Y.Z.zip
  • unzip connect-X.Y.Z
  • cd connect-X.Y.Z
  • cp ~/path/to/application.properties .
  • java -jar connect-X-Y-Z.jar

Got a secret config. file? Just copy it to the same folder as the jar:

  • cp /from/safehouse/application.properties connect-X.Y.Z

Neo4j may require some tinkering to get working. You should try to get it running and log into the web interface. This will force you to input a password. Write username and password into the application.properties file.

Notes

Production

Server doesn't support HTTPS, so put it behind nginx or something. HTTPS must be used to protect the password (sent during login) and session cookie.

Before running mvn verify make sure your neo4j server is dead. We have included a version to facilitiate testing during development, which is automatically started and shut down by the mvn verify command.

Remember to read-the-docs

Dependencies: