/nimi-api

The unofficial API for Azur Lane

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Nimi

Test

Welcome aboard! Nimi is the unofficial API that returns JSON data from Azur Lane and is always updated to the latest game version. Unlike most projects of the same mission, we're using a serverless approach for providing you these data, however, since we're iterating rapidly, there might be some bugs and of course, we change some stuff really fast so beware of maelstroms and icebergs, Captain!

Compared to previous version

Due to the stateless architecture of the new API, we are able to reach more audiences much more better than before. And thanks to the new API's architecture and Vercel, the service is now accessible anywhere in the world, we're no longer isolated in one region! You're always 80ms or 160ms away from the service.

What's next?

We're just getting started. We have a viewer coming up (and it's fully automated unlike the Azur Lane Wiki), and much more, so stay tuned! If you have any requests of your own, be sure to drop it by at the issues page.

Motivation

There aren't many data providers for this mobile game, so we decided to make one for the community. These allows aspiring developers to help out the community and opportunities like Discord bots or self-hosted websites with tools and viewers.

Consider supporting our project as well so we can keep maintaining this project! A coffee a day gives us a happy day.

ko-fi

"Philosophy Sensei Z23" art by しるこ on pixiv

Contributing

We are very open to contributions such as feature suggestions and pull requests! There are things to take note before doing so however.

Before you submit a pull request and to ensure you have a smooth time in developing and improving the project, use Visual Studio Code or any other editor that supports syntax highlighting and linting. Make sure to install the recommended extensions as well.

Our Continuous Integration configuration is contributor-neutral so the flow we use in this repository will also work on your fork, so make sure your code passes before submitting it upstream.

If you found something that isnt right, want to ask a question, or have a suggestion you'd like to be added, then please do make a new issue.

Credits



Our project is powered by Vercel! We host the project there and if you have a upcoming project, you should consider choosing Vercel as your host.

This API is Copyright © Nathan Alo and Ayane Satomi. Licensed under GNU General Public License v3.0.

Contains code from Aya. Aya's components are Copyright © Ayane Satomi, Michael Mitchell, et al. Licensed under MIT.

Azur Lane, the game, and all its assets are Copyright © Yostar. The developers and contributors are no way affiliated with the game, the company, nor its partners.

Notes

While this project is open source under GNU General Public License, commercial use of this API is prohibited. This clause is non-negotiable.