search

Nosesisaid / fumo-API

An rest API to obtain fumo images, available at fumo-api.nosesisaid.com
http://fumo-api.nosesisaid.com
MIT License
30 stars 2 forks source link
api fastify fumo fumos nodejs touhou typescript

readme

fumo API

The project is currently down

[!WARNING]
Official CDN is not currently working, since my education azure credit expired, the images are not aviable anymore. Therefore I guess the API is useless.

[!IMPORTANT]
Please if you are willing to use this project for literally anything, let me know and I will try to make it usable again, you can create an Issue on this repo or write to me Do it, for real. if you see this lmk.

Tests

Rest API of images of fumos (japanese plushies) using typescript and fastify.

logo

Documentation

Documentation available at fumo-api.nosesisaid.com/docs

Contributing

if you would like something to be different or have any suggestion, please open an issue.

Running it locally

Using node

  1. Clone the repo git clone https://github.com/nosesisaid/fumo-api.git
  2. Install dependencies yarn
  3. Copy .env.example to .env
  4. Fill the .env file with your config
  5. Build the project yarn build
  6. Run the project yarn start

    Using docker

  7. Pull the image docker pull ghcr.io/nosesisaid/fumo-api:2.0.0
  8. Run the image docker run -e MONGO_URL=<DatabaseUrl> -p <port>:3000 -d ghcr.io/nosesisaid/fumo-api:2.0.0