mirror of
https://github.com/documize/community.git
synced 2025-07-24 15:49:44 +02:00
initial commit
This commit is contained in:
commit
18933c6767
1841 changed files with 810642 additions and 0 deletions
20
sdk/README.md
Normal file
20
sdk/README.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
# SDK for the Documize system
|
||||
|
||||
The SDK is in development, please do not use in a live environment.
|
||||
|
||||
## documize command
|
||||
|
||||
The directory "documize" contains a command line utility to load files onto the Documize server.
|
||||
Run the command with "--help" to see the available flags.
|
||||
|
||||
## test suite (currently disabled)
|
||||
|
||||
The directory "exttest" contains a set of tests that are used both to test this package and to test the main documize code.
|
||||
|
||||
In order to run these tests two environment variables must be set:
|
||||
* DOCUMIZEAPI - the url of the endpoint, which must be http://localhost:5002 at present
|
||||
* DOCUMIZEAUTH - the authorization credentials in the form ```domain:email:password```,
|
||||
which must be of the form ```:mick@jagger.com:demo123``` at present,
|
||||
with the Documize DB organistion record having the default (empty) subdomain.
|
||||
|
||||
There must also be a single folder named "Test" for code to find and use. TODO(Elliott) remove this restriction.
|
Loading…
Add table
Add a link
Reference in a new issue