README.md

MikuAPI v3 💙

A random image API for Hatsune Miku.

MikuAPI is an API created to give you a random image of the popular vocaloid Hatsune Miku.

Features:

• Allow you to add your own images
• Fully working
• Users ecosystem

Check it out by yourself at https://miku-for.us/

🏠 Homepage / ✨ Discord Server

Technologies

• AdonisJS v5 for our backend/frontend.
• TailwindCSS v2 for our CSS. database.
• PostgreSQL for our database.
• Yarn for our package manager.

Install

yarn

Usage

Test in development:

yarn dev

Build for production:

yarn build

This project is proudly ran by AdonisJS v5. Consider reading their documentation to use this project.

If you're using PM2 for running MikuAPI, you'll require PostgreSQL to work correcty, or manually edit ecosystem.config.js. In development, the DB will be mikuapi_dev, in production, the DB will be mikuapi.

Author

🔨 Predeactor

When I installed the app for production for first time, the DB was SQLite3 in the /tmp folder.

• Website: https://predeactor.net
• Twitter: @Predeactor1
• Github: @Predeactor
• Discord: Capt. Pred#0495 (Come find me at my server!)

Show your support

This project is not supported by anyone and is pretty personal, I enjoy making it just because I wanted one. You're free to ⭐ star this project to show me you enjoy it! You can also donate to me using Patreon.