Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rohitedathil/project_card

A service to display a quick summary of a project on GitHub.
https://github.com/rohitedathil/project_card

card fastapi github hacktoberfest jinja2 project-showcase python readme readme-profile svg

Last synced: 19 days ago
JSON representation

A service to display a quick summary of a project on GitHub.

Awesome Lists containing this project

README

        

A service to display a quick summary of a project on GitHub.

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)
![Heroku](https://img.shields.io/badge/heroku-%23430098.svg?style=for-the-badge&logo=heroku&logoColor=white)

# Usage 📖

Paste the code below with details filled in as specified below into your Readme.md.

`{repo}` is the name of the repository.

`{user}` is the name of the user.

```
[![Project Card](https://projectcard.rohitv.repl.co/project_card/{user}/{repo})](https://github.com/{user}/{repo})
```

An example of the project card:

Here,

`{repo}` : `linux`

`{user}` : `torvalds`

[![Project Card](https://projectcard.rohitv.repl.co/project_card/torvalds/linux)](https://github.com/torvalds/linux)

## Themes 🎨

You can change the theme of the project card by adding a `theme` parameter to the URL.

```
[![Project Card](https://projectcard.rohitv.repl.co/project_card/{user}/{repo}?theme={theme})](https://github.com/{user}/{repo})
```

### Available Themes

- `dark-blue` (default)

[![Project Card](https://projectcard.rohitv.repl.co/project_card/torvalds/linux?theme=dark-blue)](https://github.com/torvalds/linux)

- `light`

[![Project Card](https://projectcard.rohitv.repl.co/project_card/torvalds/linux?theme=light)](https://github.com/torvalds/linux)

- `violet`

[![Project Card](https://projectcard.rohitv.repl.co/project_card/torvalds/linux?theme=violet)](https://github.com/torvalds/linux)

- `dark-green`

[![Project Card](https://projectcard.rohitv.repl.co/project_card/torvalds/linux?theme=dark-green)](https://github.com/torvalds/linux)

- `greyscale`

[![Project Card](https://projectcard.rohitv.repl.co/project_card/torvalds/linux?theme=greyscale)](https://github.com/torvalds/linux)
More themes coming soon ...

## Any contributions are welcome 😀