Code Monkey home page Code Monkey logo

profile-cards-api's Introduction

Profile Cards API

Profile Card Example

The Profile Cards API is an open-source service that generates profile card images based on the information provided via API requests. These profile cards can be used in various applications, including GitHub profiles, personal websites, and more.

Usage

To generate a profile card, make a GET request to the API with the following query parameters:

  • name*: The name to be displayed on the profile card.
  • location*: The user's location or city.
  • title*: The user's job title or description.
  • imageLink*: The URL of the user's profile picture.
  • socialMedia: The name of social media whose username you want to show
  • socialMediaUsername: The username of the previously specified social media

The parameters marked with asterisk(*) are required paramaters. However, if they are not provided, the API will still generate an image with default values.

Example API request:

GET https://profile-cards-api.vercel.app/api/profile?name=Prince%20Raj&location=India&title=Web%20Developer&imageLink=https://images.unsplash.com/photo-1514501259756-f4b6fbeffa67&socialMedia=Github&socialMediaUsername=theprinceraj

This will return an image of a profile card with the provided information.

Latest Updates

  1. Added front-end interface website for forming and copying direct links of the generated images instead of manually editing links. The webpage is available at Profiles Cards API Frontend. The frontend website also shows a live preview based on input field values in real time.
  2. Implemented debouncing logic to API calls made on the front-end website to show a live preview only when the user stops typing or editing a field.

Customization

It does not support design customisation as of now but I plan to implement it sometime later. Contributions in this regard are most welcome.

Dependencies

  • Express.js: The web server framework for handling API requests.
  • canvas-constructor: Used to generate profile card images.
  • canvas: Used to generate profile card images.

Contributors

Contributions to this project are welcome. Feel free to open issues or pull requests to suggest improvements or report bugs.

Once we have contributors, we will list them down in this section. I hope we will have more soon!❤️

  1. sarcasterXO
  2. theprinceraj

License

This project is open-source and available under the MIT License.


profile-cards-api's People

Contributors

theprinceraj avatar sarcasterxo avatar

Stargazers

Jenu_1235_ avatar Ankur Das avatar  avatar Ankit Das  avatar Rohan Singh avatar Dhananjay Thomble avatar  avatar

Watchers

 avatar

Forkers

mrinaldotexe

profile-cards-api's Issues

Adding a throbber(i.e. spinning circle) to image input field

Is your feature request related to a problem? Please describe.
I am always clueless of whether the image that I attach through the image input field gets processed correctly or not until the generated image link appears on the image input field.

Describe the solution you'd like
A throbber at the center of the image input field should be displayed when an image is attached using the upload button and the throbber should be present there as long as the generated image link is received back from the backend server.

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.