Going Further

If you want to learn more about the library the best way is to look at some code! Here you can find some working examples:

Hello World

Users & Posts

Sandbox

Other than that, don't be afraid to go into the source code. It's written in TypeScript, so you'll probably learn more by looking at it. You may find test files (ending in .test.ts) particularly helpful.

Extending the Library

In order to extend the library for specific use cases, you probably only need to extend one or two contracts: the Engine (opens new window) interface and the Model (opens new window) class.

If you want to find some existing extensions, search for the #soukai (opens new window) and #soukai-engine (opens new window) topics in GitHub and elsewhere.

Contributing

Feel free to report any bugs or open pull requests in the Github repository (opens new window).

If you are thinking on developing new functionality, you should start by opening an issue (opens new window) to discuss it. We won't accept any contributions right out the door, so it's better to discuss it before you start working on it.