https://github.com/michael-obele/github-banner
A customizable contribution graph image generator designed for creating banners on social media platforms. Personalize text and showcase your GitHub activity in style!
https://github.com/michael-obele/github-banner
banner-generator branding github image-generation open-source visualization
Last synced: about 2 months ago
JSON representation
A customizable contribution graph image generator designed for creating banners on social media platforms. Personalize text and showcase your GitHub activity in style!
- Host: GitHub
- URL: https://github.com/michael-obele/github-banner
- Owner: Michael-Obele
- License: mit
- Created: 2025-01-10T03:31:06.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-01-10T18:29:14.000Z (4 months ago)
- Last Synced: 2025-01-29T00:52:40.350Z (4 months ago)
- Topics: banner-generator, branding, github, image-generation, open-source, visualization
- Language: Svelte
- Homepage: https://gitbanner.svelte-apps.me/
- Size: 222 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Contribution Banner Generator
An app for creating banner images for social media apps like Twitter and LinkedIn using GitHub contribution graphs.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Introduction
This project allows users to generate banner images for social media platforms using GitHub contribution graphs. Users can customize the text displayed on the banner.
## Features
- Generate banner images from GitHub contribution graphs
- Customize text on the banner
- Download the generated banner image
- Share the banner on social media platforms
## Installation
To get started with the project, clone the repository and install the dependencies:
```bash
git clone https://github.com/your-username/github-banner.git
cd github-banner
npm install
```
## Usage
Once you've installed the dependencies, start the development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
To create a production version of your app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
## Contributing
Contributions are welcome! If you'd like to contribute, please follow these steps:
1. Fork the repository
2. Create a new branch (`git checkout -b feature-branch`)
3. Make your changes
4. Commit your changes (`git commit -m 'Add some feature'`)
5. Push to the branch (`git push origin feature-branch`)
6. Open a pull request
Please make sure to update tests as appropriate.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.