Difference between revisions of "Developing"

From BaseX Documentation
Jump to navigation Jump to search
m (→‎Requirements: added macven)
 
(126 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Requirements==
+
This page is one of the [[Main Page|Main Sections]] of the documentation.
*[[Subversion Repository]]: Checkout the projects
+
It provides useful information for developers. Here you can find information
*[[Maven]] to faciliate building our projects from sources
+
on various alternatives to integrate BaseX into your own project.
*[[Integrate]]: Integrate BaseX into your IDE
 
  
==Examples==
+
<table><tr><td width='50%' valign='top'>
*[[Coding examples]]: Examples for developing with the BaseX code base in Java
+
;Integrate & Contribute
 +
* [[Developing with Eclipse|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!
  
==JavaDoc==
+
;Web Technology
* See our Javadocs [http://www.inf.uni-konstanz.de/dbis/basex/javadoc/ here...]
+
* [[RESTXQ]]: Write web services with XQuery
 +
* [[REST]]: Access and update databases via HTTP requests
 +
* [[WebDAV]]: Access databases from your filesystem
 +
</td><td width='50%' valign='top'>
  
==Client Interfaces==
+
;APIs
*[[Language bindings]]: Communicate with the BaseX server using the different language bindings
+
* [[Clients]]: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
*[[REST Interface]]: Communicate with the BaseX server using the REST interface
+
* [[Java Examples]]: Code examples for developing with BaseX
 +
* [http://xqj.net/basex XQJ API]: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
 +
* [https://github.com/fancellu/xqs XQuery for Scala API], based on XQJ and written by Dino Fancellu
  
[[Category:Developer]]
+
;Extensions
 +
* [[YAJSW|Service/daemon]]: Install BaseX server as a service
 +
* [[Android]]: Running BaseX with Android
 +
</td></tr>
 +
</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__

Latest revision as of 11:18, 28 July 2022

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
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.