Daltonic / quoteLab

This app creates an image with your quote written on it

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Quotes Lab

An awesome web-app that converts an HTML element into an image such as a quote.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Quotes Lab Screenshot

Quotes Lab is a web application for converting HTML mockups to images. Quotes Lab leverages on Pixabay's API and the dom-to-image-more npm package to produce a high-quality image in base64. All these are layered together inside the VueJs 3 JavaScript framework.

Built With

The following tools were used in the building of Quotes Lab.

Getting Started

To get this project running on your system observe and implement the following procedures.

Prerequisites

Get the latest VueJs CLI installed on your machine by entering this command on your terminal.

  • npm
    npm install -g @vue/cli

Installation

  1. Get a free API Key at Pixabay's Doc
  2. Clone the repo
    git clone https://github.com/Daltonic/quoteLab.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

Usage

When you visit the app domain at Quotes Lab, enter the keyword of the image you want to convert to a quote.

Quotes Lab Hero Screen Shot

After entering your keyword cards of images will be rendered on the page on which you should select any to proceed to the next step. You can always click on the Load more button if you are not satisfied with the image result.

Quotes Lab Images Screenshot

After selecting an image you proceed to enter your quote and your name within the form below.

Quotes Lab Editor Screenshot

Once you are done editing your quote, you click on the capture button to convert it to an image and the output will be seen below.

Quotes Lab Output Screenshot

Within this component are two buttons, one gets the image downloaded to your device while the other removes the image from the view.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Gospel Darlington - Facebook - darlingtongospel@gmail.com

Project Link: https://github.com/Daltonic/quoteLab

Acknowledgements

About

This app creates an image with your quote written on it


Languages

Language:Vue 79.7%Language:JavaScript 12.6%Language:HTML 7.7%