https://github.com/lucmsilva651/random-readme-image-api
A Node.js API that serves random images on your README.
https://github.com/lucmsilva651/random-readme-image-api
image-api nodejs readme
Last synced: 7 months ago
JSON representation
A Node.js API that serves random images on your README.
- Host: GitHub
- URL: https://github.com/lucmsilva651/random-readme-image-api
- Owner: lucmsilva651
- License: bsd-3-clause
- Created: 2025-03-25T02:49:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T15:51:18.000Z (about 1 year ago)
- Last Synced: 2025-06-07T23:51:06.811Z (11 months ago)
- Topics: image-api, nodejs, readme
- Language: JavaScript
- Homepage:
- Size: 1.38 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Random README Image API
A Node.js API that serves random images on your readme.
## Installation
- Clone the repository with Git or download the source.
- Put your desired images on ``images`` inside the ``src`` folder.
- Install all project dependencies with ``npm i`` or ``bun i``.
- Run the server with ``npm start`` or ``bun start``.
### Deploy with Vercel
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flucmsilva651%2Frandom-readme-image-api&project-name=random-readme-image-api&repository-name=random-readme-image-api&redirect-url=https%3A%2F%2Fgithub.com%2Flucmsilva651%2Frandom-readme-image-api%2F)
## Development: Personal tip
While testing, you can use ``nodemon`` to avoid restarting manually the server whenever you changed something.
- Install ``nodemon`` with ``npm i nodemon -g`` or ``bun i nodemon -g``
- Then run it with just ``nodemon``.
With this, you can avoid restarting your server manually. Do not worry. ``nodemon`` restarts the server whenever you changed some file.
## Notes
Please read this carefully if you are really going to use this:
- Images are being served on a 1:1 aspect ratio, with the resolution being 300x300 by default. Feel free to change this if you want.
- Ignore the sample images. These are only meant to be on my personal README.
- Only requests from GitHub's Camo service are allowed.
## License
2025 Lucas Gabriel (lucmsilva) - BSD 3-Clause