Skip to content

Latest commit

 

History

History
executable file
·
82 lines (56 loc) · 2.76 KB

README.md

File metadata and controls

executable file
·
82 lines (56 loc) · 2.76 KB
Raw

Prerequisites

Badgeyay backend depends on:

  • python3

  • postgress SQL

    • For Ubuntu/Debian based package managers

      sudo apt-get update
sudo apt-get install python3 postgresql postgresql-contrib

    • For Fedora/CentOS/RPM based package managers

      sudo -i
yum install python3 postgresql postgresql-contrib
exit

    • For Arch based package managers:

      sudo pacman -S python-cairosvg
sudo pacman -S python-lxml
sudo pacman -S postgresql

    • For MacOS

      brew install python
brew install postgres
      • To install Homebrew 
        /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
        Paste it in MacOS Terminal prompt .

In addition to the above zlib-dev, libxml2, and jpeg must be present. (Most distros have them pre-installed)

Installation

Badgeyay backend can be easily deployed on a variety of platforms. Currently it can be deployed in following ways.

  1. Local Installation using Virtual environment

  2. Local Installation using Vagrant environment

  3. Deployment on Heroku

  4. Deployment with Docker

  5. Deployment on AWS EC2

One-click Docker, Heroku, Scalingo and Bluemix deployment is also available:

Deploy to Docker Cloud Deploy Deploy on Scalingo Deploy to Bluemix

Testing Methodology Used

Working

Input

  • The input can be a set of csv files(UTF-8) or a manual entry.
  • Detailed Information on the Correct format of Input can be found at Badgeyay User-Input Guide.

Output

  • The output file is a pdf of size A3.
  • Each badge has the size A6.
  • The outputs are in a folder derived from the input csv.

Customization

  • You can change the font style, font size, color etc from the .svg file in the folder badges.
  • Inkscape is generally used for editing of such files.