Skip to content

Posterfy turns your favorite albums into stunning visual posters. Powered by Spotify's API, create custom album covers with personalized colors, themes, and more. Perfect for music lovers and designers alike!

License

Notifications You must be signed in to change notification settings

avictormorais/posterfy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Posterfy Logo

Posterfy

Create stunning posters of your favorite albums powered by Spotify's API

License: CC BY-NC-ND 4.0 Live Demo GitHub stars

๐Ÿ”ญ Overview

Posterfy is an open-source web application that allows users to create visually appealing posters for their favorite music albums. Powered by Spotifyโ€™s free API, Posterfy enables users to search for albums, gather album data, and organize the information into a custom poster using the HTML Canvas element.

This project is educational, non-commercial, and fully open to contributions. All rights to the images and data are owned by Spotify and the respective artists.

๐Ÿ–ผ๏ธ Demo

Posterfy Example Posters

Examples of posters created with Posterfy

๐Ÿ”ง How It Works

1๏ธโƒฃ Search for Album: Users enter the name of the album they want to create a poster for.

2๏ธโƒฃ Select Album: Posterfy displays search results, and users can select their desired album.

3๏ธโƒฃ Data Gathering: Once the album is selected, Posterfy fetches all the necessary data and images from Spotifyโ€™s API.

4๏ธโƒฃ Visual Organization: The gathered data is then visually organized into a custom layout using the HTML Canvas element.

5๏ธโƒฃ Poster Generation: Finally, a rendered image of the poster is generated, which the user can save or share.


โ“ FAQ

Q: Can I use Posterfy without a Spotify account?
A: Yes, you donโ€™t need a Spotify account to create posters, but you will need to set up Spotify credentials to run the app locally.

Q: Is it possible to create a poster with a custom album?
A: Currently, Posterfy only supports albums from Spotifyโ€™s database. Custom albums are not supported yet.

Q: What file format can I export the poster in?
A: Posters can be exported as PNG images.

Ways to Contribute

  • ๐Ÿ› Bug Reports: Found a bug? Open an issue
  • ๐Ÿ’ก Feature Requests: Have an idea? We'd love to hear it!
  • ๐ŸŒ Translations: Help make Posterfy available in more languages
  • ๐Ÿ“– Documentation: Improve our docs and examples
  • ๐ŸŽจ Design: Contribute new poster templates and styles

Code Guidelines

  • Follow the existing code style and conventions
  • Write clear, descriptive commit messages
  • Add tests for new features when applicable
  • Update documentation as needed

๐ŸŽ‰ Acknowledgments

Special thanks to all contributors who have helped make Posterfy better:

  • debug420 - For valuable improvements and feature contributions
  • All beta testers and community members providing feedbackr> No, you don't need a Spotify account to create posters. However, developers need Spotify API credentials to run the app locally.
Can I create posters for custom/local albums?
Currently, Posterfy only supports albums available in Spotify's database. Support for custom albums may be added in future versions.
What image formats are supported for export?
Posters can be exported as high-quality PNG images. Additional formats may be supported in future updates.
Is there a mobile app available?
Posterfy is a web application that works perfectly on mobile browsers. There's no dedicated mobile app at this time.
Can I use these posters commercially?
No, this project is for educational and non-commercial use only. All album artwork and data belong to Spotify and the respective artists.

โœจ Features

  • ๐Ÿ” Smart Search: Find any album from Spotify's vast database
  • ๐ŸŽจ Multiple Templates: Choose from various poster layouts and styles
  • ๐ŸŽฏ High-Quality Output: Export posters in PNG format with crisp quality
  • ๐Ÿ“ฑ Mobile Friendly: Responsive design that works on all devices
  • โšก Fast Performance: Built with React and Vite for optimal speed
  • ๐ŸŒ Multilingual: Support for multiple languages
  • ๐ŸŽญ Custom Styling: Personalize colors, fonts, and layout options

๐Ÿš€ Getting Started

Prerequisites

  • Node.js (version 16 or higher)
  • npm or yarn package manager
  • Spotify Developer Account (for API credentials)

Installation

  1. Clone the repository

    git clone https://github.com/avictormorais/posterfy.git
    cd posterfy
  2. Install dependencies

    npm install
  3. Set up environment variables

    Create a .env file in the root directory and add your Spotify API credentials:

    VITE_SPOTIFY_CLIENT_ID=your_spotify_client_id
    VITE_SPOTIFY_CLIENT_SECRET=your_spotify_client_secret

    ๐Ÿ’ก Getting Spotify Credentials: Visit the Spotify Developer Dashboard to create an app and get your credentials.

  4. Start the development server

    npm run dev
  5. Open your browser

    Navigate to http://localhost:5173 to see the application running.

Production Build

To build the project for production:

npm run build

The optimized files will be generated in the dist/ directory.

๐Ÿค Contributing

We welcome contributions to Posterfy! 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 and commit them (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a Pull Request.

Please ensure that your code passes all tests and adheres to the projectโ€™s style guide.

๐ŸŽ‰ Community Contributions

A huge thank you to debug420 for contributing improvements to Posterfy! This fork introduced some great new features, your contributions help make Posterfy even better. ๐Ÿš€

๐Ÿ“„ License

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0) license.

License Summary

Permission Allowed
โœ… Share Copy and redistribute the material in any medium or format
โŒ Commercial Use Cannot use for commercial purposes
โŒ Modify Cannot remix, transform, or build upon the material
โš ๏ธ Attribution Must give appropriate credit and link to license

For complete license terms, see the LICENSE file or visit creativecommons.org.

โš ๏ธ Disclaimer

  • ๐ŸŽ“ Educational Purpose: This project is created for educational and non-commercial purposes only
  • ๐ŸŽต Content Rights: All album artwork, data, and information belong to Spotify and the respective artists
  • ๐Ÿ›ก๏ธ No Warranty: This software is provided "as is" without any warranty
  • ๐Ÿ“Š Analytics: This app may collect anonymous usage data to improve user experience

Made with โค๏ธ by Victor Morais

โญ Star this project if you found it helpful!

About

Posterfy turns your favorite albums into stunning visual posters. Powered by Spotify's API, create custom album covers with personalized colors, themes, and more. Perfect for music lovers and designers alike!

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •