> For the complete documentation index, see [llms.txt](https://sakuraapi.gitbook.io/sakuraapi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sakuraapi.gitbook.io/sakuraapi/master.md).

# Introduction

SakuraApi is a modern NodeJS framework optimized for use with MongoDB and TypeScript.

You can best experience this documentation at <https://sakuraapi.gitbook.io/sakuraapi/>.

A quick way to get started is by installing and using the SakuraApi CLI. Note the version number, however. If it's not the same as the current version of `@sakuraapi/core`, there's a chance that it might not work properly as things are rapidly evolving.&#x20;

```javascript
npm i -g @sakuraapi/cli
sapi init sample
```

## Contributing

[![CLA assistant](https://cla-assistant.io/readme/badge/sakuraapi/manual)](https://cla-assistant.io/sakuraapi/manual)

* Sign the CLA
* Fork the repo, make your changes, then open a Pull Request
* Ideally, you should open an issue first (<https://github.com/sakuraapi/manual/issues>) and commit against that issue

For the occasional contributor to this documentation, opening a pull request at <https://github.com/sakuraapi/manual> is the best approach. If you'd like to become a significant contributor to this documentation (and we'd love it if you were interested in that!) then please open an issue introducing yourself here: <https://github.com/sakuraapi/manual/issues>. Thanks.&#x20;