github.com/elliott5/community@v0.14.1-0.20160709191136-823126fb026a/sdk/README.md (about)

     1  # SDK for the Documize system
     2  
     3  The SDK is in development, please do not use in a live environment.
     4  
     5  ## documize command
     6  
     7  The directory "documize" contains a command line utility to load files onto the Documize server. 
     8  Run the command with "--help" to see the available flags.
     9  
    10  ## test suite (currently disabled)
    11  
    12  The directory "exttest" contains a set of tests that are used both to test this package and to test the main documize code.
    13  
    14  In order to run these tests two environment variables must be set:
    15  * DOCUMIZEAPI - the url of the endpoint, which must be http://localhost:5002 at present
    16  * DOCUMIZEAUTH - the authorization credentials in the form ```domain:email:password```, 
    17  which must be of the form ```:mick@jagger.com:demo123``` at present,
    18  with the Documize DB organistion record having the default (empty) subdomain.
    19  		
    20  There must also be a single folder named "Test" for code to find and use. TODO(Elliott) remove this restriction.