Skip to content

Latest commit

 

History

History
66 lines (59 loc) · 2.98 KB

README.md

File metadata and controls

66 lines (59 loc) · 2.98 KB
Raw

Clue-Solver

See Project Site for reports and api

Building the Workspace

  1. Run the command from console mvn eclipse:eclipse
    • If your build for myeclipse the command is mvn eclipse:myeclipse
    • If you need to undo the generation use mvn eclipse:clean
  2. After the command is run you should be able to import the project as you normally do from the git repositories view or from. File -> Import -> Existing Projects into Workspace
  3. For more information about the changes Maven Eclipse Generator

Build Instructions

Requirements

Building

  1. Clone full repo from git
  2. Navigate to the base directory of git repo.
  3. Run command 'mvn clean package'
    • This will run all tests and should produce project artifacts

Generating Enunciate

  1. Run mvn clean site from root of project

Clue Solver Rest

Rest Server Tech/Dependencies

  • Restlet 2.0.13
    • Provides the basic REST server interfaces, including handling all the thread management
    • Allows us to serve straight from a jar with no server additional server configuration
    • Restlet Home Page
  • Jackson
    • Automatic conversion from Java Objects to JSON objects and back
    • Currently our rest server uses no configuration and lets Jackson automatically convert
    • Jackson Home Page
  • JAXB
    • Handles conversion from Java to XML and back
    • Annotated objects in the Clue-Solver-Models module
    • If adding a new object be sure to add it to jaxb.index for that package so that it can be created
    • Part of standard JDK
  • Enunciate
    • Generates the API documentation including the active paths that can be connected to
    • Generates the XML information such as examples
    • Generates code that handles connection and conversion in C#, Java, and C
    • Automatically runs from maven and outputs to /target/site/wsdocs
    • Enunciate Home Page

Api Docs

After running mvn clean site the full API docs should be available in the directory Clue-Solver-Rest/target/site/wsdocs/index.html Navigating from this site will also allow you to download any of the generated code libraries The site is full navigable from the html in the target directory, does not need to be deployed to a server