Difference between revisions of "Developing"

From BaseX Documentation
Jump to navigation Jump to search
(45 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
on various alternatives to integrate BaseX into your own project.
 
on various alternatives to integrate BaseX into your own project.
  
<div style="float:left; width:48%;">
+
<table><tr><td width='50%' valign='top'>
{{Large|Integrate & Contribute}}
+
;Integrate & Contribute
* [[Integrate]]: Compile and run BaseX from within Eclipse.
+
* [[Developing with Eclipse|Eclipse]]: Compile and run BaseX from within Eclipse
* [[Git]]: Learn how to work with Git.
+
* [[Git]]: Learn how to work with Git
* [[Maven]]: Embed BaseX into your own projects.
+
* [[Maven]]: Embed BaseX into your own projects
* [[Releases]]: Official releases, snapshots, old versions.
+
* [[Releases]]: Official releases, snapshots, old versions
 
* [[Translations]]: Contribute a new translation to BaseX!
 
* [[Translations]]: Contribute a new translation to BaseX!
  
{{Large|JavaDoc}}
+
;Web Technology
The project's [http://docs.basex.org/javadoc JavaDoc] can be explored online.<br/><br/>
+
* [[RESTXQ]]: Write web services with XQuery
 +
* [[REST]]: Access and update databases via HTTP requests
 +
* [[WebDAV]]: Access databases from your filesystem
 +
* [[XForms]]: Build browser forms with XML technologies
 +
</td><td width='50%' valign='top'>
  
</div><div style="float:left; width:4%;">&nbsp;
+
;APIs
</div><div style="float:left; width:48%;">
+
* [[Clients]]: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
{{Large|HTTP Services}}
+
* [[Java Examples]]: Code examples for developing with BaseX
* [[REST]]: Access and update databases via HTTP requests.
+
* [http://xqj.net/basex XQJ API]: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
* {{Version|7.2}}: [[RESTXQ]]: Write web services with XQuery.
+
* [https://github.com/fancellu/xqs XQuery for Scala API], based on XQJ and written by Dino Fancellu
* [[WebDAV]]: Access databases from your filesystem.
 
  
{{Large|Client APIs}}
+
;Extensions
* [[Clients]]: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
+
* [[Docker]]: Isolate BaseX in a docker container
* [[Server Protocol]]: Implement your own language bindings
+
* [[YAJSW|Service/daemon]]: Install BaseX server as a service
* [[Java Examples]]: Code examples for developing with BaseX<br/><br/>
+
* [[Android]]: Running BaseX with Android
</div>
+
</td></tr>
[[Category:Developer]]
+
</table>
 +
 
 +
;Code, Questions, Bugs
 +
* The [https://github.com/basexdb/basex Source Code] is available on GitHub.
 +
* For questions, bug reports and feature requests, please write to our [https://basex.org/open-source/ mailing list]
 +
* The [https://github.com/basexdb/basex/issues Issue Tracker] contains confirmed bugs and feature requests.
 +
__NOTOC__

Revision as of 09:47, 6 September 2020

This page is one of the Main Sections of the documentation. It provides useful information for developers. Here you can find information on various alternatives to integrate BaseX into your own project.

Integrate & Contribute
  • Eclipse: Compile and run BaseX from within Eclipse
  • Git: Learn how to work with Git
  • Maven: Embed BaseX into your own projects
  • Releases: Official releases, snapshots, old versions
  • Translations: Contribute a new translation to BaseX!
Web Technology
  • RESTXQ: Write web services with XQuery
  • REST: Access and update databases via HTTP requests
  • WebDAV: Access databases from your filesystem
  • XForms: Build browser forms with XML technologies
APIs
  • Clients: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
  • Java Examples: Code examples for developing with BaseX
  • XQJ API: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
  • XQuery for Scala API, based on XQJ and written by Dino Fancellu
Extensions
Code, Questions, Bugs
  • The Source Code is available on GitHub.
  • For questions, bug reports and feature requests, please write to our mailing list
  • The Issue Tracker contains confirmed bugs and feature requests.