Giter VIP home page Giter VIP logo

fumo-api's Introduction

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

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

fumo-api's People

Contributors

codacy-badger avatar dependabot[bot] avatar hyduez avatar v1ctorio avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

grotor1 v1ctorio

fumo-api's Issues

OpenAPI

Document the API using OpenAPI.

Suggestion object values

cirnu

Fumo issue

To be honest, the object that the Rest API returns is a little, if not a lot, fit to function as an API. I know that there are a lot of Fumos in the database, and that they might find it tedious, but it's the right thing to do, they should do it. The object that returns contains the ID of the object in MongoDB and the link of the image; that it is not a unique CDN, since there are links of the cdn of Discord or Telegram. It would also be useful if they put the name, or names, of the smoke that appears in the url image. They could take advantage of this and at once completely revamp the Rest API, including the database.

TODO list:

  • #15
  • #14
  • Renovate the database

Missing rate limit

Missing rate-limit

The bot doesn't have a rate limit and anyone can abuse of this.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.