SXAPI User guides

This section will help you find several user guide to get hand on the sxapi-core project. For more information you can visit the sxapi-core project page.

Getting started User guides

sxapi could be used in 3 ways : container, npm module or from source code. You will find a user guide for each one of these usage in the following sections :

Step by step guides

  1. Install you sxapi with the installation guide
  2. Configure your own API following the configuration guide
  3. Execute your application using the running application guide
  4. Extend application capacity with the developping guide
  5. Participate to this open-source project according to the contributing guide
  6. Using the sxapi kubernetes operator

Contributing

Read the contributing guide for details on our code of conduct, and the process for submitting pull requests to us.

Authors

This project is mainly developped by the startx dev team. You can see the complete list of contributors who participated in this project by reading contributors.md.

License

This project is licensed under the GPL Version 3 - see the LICENCE file for details