Skip to content

Latest commit

 

History

History
347 lines (212 loc) · 13.3 KB

README.md

File metadata and controls

347 lines (212 loc) · 13.3 KB

Contributors Forks Stargazers Issues GPL License


Logo

Pixelf

A Pixel Art Project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Images
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Product Name Screen Shot

Welcome to Pixelf, a powerful web application that lets you customize your images to suit your preferences. Our platform is designed to make the process of transforming images into beautiful works of art seamless and intuitive. Whether you are an experienced artist or a hobbyist, Pixelf offers a range of options to help you bring your creative vision to life.

At Pixelf, we understand the importance of customization. That's why we offer an array of options to modify your images, including adjusting block size, color palette, and converting images to grayscale. Our website also provides a range of styles, including pixel, linear, and cubic, to give your images a unique touch.

But that's not all. Pixelf also offers the option to customize your images using the K-Means algorithm. By selecting the similar colors option, our website can adjust the colors in your images to create stunning visuals. Our image processing technology is powered by C++, which takes values from JavaScript as environment variables to create images that are nothing short of breathtaking.

We believe that Pixelf is an excellent tool for anyone looking to take their image customization game to the next level. Our platform is user-friendly, making it easy for users of all skill levels to navigate and modify their images. By exploring the options available on our website, you can experiment and let your creativity run wild.

Thank you for choosing Pixelf, and we hope that our platform exceeds your expectations. If you have any questions or feedback, please don't hesitate to contact us.

(back to top)

Built With

Pixelf is built using a combination of C++, JavaScript, HTML, CSS, and Node.js with Express.js as the backend framework.

  • javascript
  • html
  • css
  • node
  • express
  • c++
  • openCV

(back to top)

Getting Started

Getting started with Pixelf is easy! To begin, simply visit our website and click on the "Upload" button to upload your image. Once your image is uploaded, you can use our intuitive interface to customize your image with various options, including block size, color palette, style, and K-Means algorithm for similar colors.

To customize your image, simply adjust the values for the options mentioned above, and the preview will update automatically. Once you are satisfied with the changes, click on the "Download" button to save your customized image to your device.

If you're interested in exploring the code behind Pixelf, you can also download it and run it on your local machine by following the instructions provided in our documentation.

Prerequisites

To install the required files, please enter the following commands into your terminal:

npm install 

Installation

Installing the Pixelf is quick and easy. Follow these simple steps to get started in just a few minutes!

  1. To build the Pixelf files on your local machine, you'll need to download and install Visual Studio 2019 or a newer version.

  2. Clone the repository to your local machine:

    git clone https://github.com/UtkuAltnkaya/Pixelf
  3. Install the required dependencies:

    npm install

    Note: While it is possible to build Pixelf using other compilers, we recommend using Visual Studio 2019 or a newer version to ensure compatibility and avoid potential errors during the build process.

  4. Open the project in Visual Studio Code or your preferred code editor.

  5. To start the Pixelf backend, navigate to the "Backend" folder in your command prompt or terminal and type "npm run dev" to launch the development server.

    That's it! You're now ready to use the Pixelf.

(back to top)

Images

Getting Started

Above you can see the getting started section.

cards-section

Here, you can see our image cards that showcase sample images customized with Pixelf.

how-to-section

The photograph includes a "How to pixel an Image" section that provides a visual guide on how to use Pixelf to customize your images.

upload

The "Upload" section on the modal allows you to easily upload an image that you wish to customize with Pixelf. Simply click on the "Upload" button, select your image file, and it will be instantly loaded into the Pixelf interface for editing.

download

Once you've customized your image to your liking with Pixelf, you can download the final result by clicking the "Download" button. Pixelf is completely free to use, and you can download your customized images at no cost.

See the files for the detailed explanations on the code.

(back to top)

License

Distributed under the GNU General Public License v3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Bayram Alper KILIÇ - @alperrkilic - [email protected]
LinkedIn Github Gmail

Turgut Utku ALTINKAYA - @UtkuAltnkaya - [email protected]

LinkedIn Github Gmail

Burak ATEŞ - @AtesBurak1 - [email protected]

LinkedIn Github Gmail

Project Link: https://github.com/UtkuAltnkaya/Pixelf

(back to top)

Acknowledgments

Creating a project like the Pixelf requires a lot of research, experimentation, and dedication. We would like to take this opportunity to acknowledge and thank the many individuals, channels, and websites that helped us along the way. Without their guidance and support, this project would not have been possible. In particular, we would like to recommend the following channels and websites for their invaluable resources and contributions to the field of web development and image processing.

(back to top)