fumo API

Important

This version is deprecated. V3 is almost ready. Take a look at #26

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

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