Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

VectorLogoZone/vlz-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VectorLogoZone Tools VectorLogoZone Logo

These are some interactive tools and the backend APIs used by the main VectorLogoZone website.

Using the API

Unfortunately, rate-limits mean that I cannot run it as an open service. However, it is fairly easy to run your own instance.

Running

It is a TypeScript node.js app, so (once you have set the settings):

yarn install
yarn run build
yarn run start

See the run.sh for how I run it in development.

Settings

All settings are stored in environment variables. The deploy and run scripts get them from a .env file.

name description
TWITTER_BEARER_TOKEN token for the Twitter API. Check twitter_get_token.sh to see how I got mine.
USERNAME (not currently used) the username to enter in the basic-auth dialog (default=admin)
PASSWORD (not currently used) the password to enter in the basic-auth dialog (default=password)

Endpoints

  • /api/twitter.json - takes id parameter
  • /api/github.json - takes id parameter

Contributing

Contributions are welcome! Please follow the standard Github Fork & Pull Request Workflow

See the to do list for a list of things that are planned.

License

GNU Affero General Public License v3.0

Credits

Website:

Cloudflare Git Github Google Analytics Google Cloud Run Handlebars Koa Node.js pino Shoelace CSS TypeScript yarn

API Data Sources:

Github Twitter SVG Logo Search

To do:

SuperTinyIcons SVGPorn InstantLogoSearch

About

Tools and backend API for VectorLogoZone

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •