Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 3.04 KB

README.md

File metadata and controls

82 lines (61 loc) · 3.04 KB

Image Showcase

License GitHub Actions Workflow Status Sonar Quality Gate Sonar Coverage Live Demo

⚠️ Work in progress ⚠️

Features

  • Image gallery (masonry layout)
  • Image zooming
  • Image EXIF data
  • Multiple galleries
  • Gallery management

Installation

  1. Installation
    Choose one of the following methods:

    a. Vercel deployment
    Deploy with Vercel

    b. Manual installation

    • Clone this repository
    • Build the project using npm run build
    • The app can be started using npm start
  2. Setup the image list (temporary)
    Create a JSON file that contains your images in this format :

    {
      "id": "1",
      "src": "https://placehold.co/800x600/png?text=1",
      "width": 800,
      "height": 600,
      "title": "Image 1"
    }

    ➡️ File example

  3. Set the following environment variables

    ENVIRONMENT=production
    
    # Open Graph Metadata
    # Application name (e.g. Image Showcase)
    APP_NAME=
    # Website description (e.g. My Image Gallery)
    APP_DESCRIPTION=
    # Comma separated website key words (e.g. gallery, myname, showcase)
    APP_KEYWORDS=
    # Application production url
    APP_URL=
    
    # URL to the image list (c.f. 2.)
    IMAGES_URL=
    
    # Your timezone and default locale (only fr and en are supported)
    TIMEZONE=Europe/Paris
    DEFAULT_LOCALE=fr
    
    # Comma separated patterns to the image hosts (e.g. cdn.mydomain.com, placehold.co, *.pixabay.com)
    IMAGE_HOSTNAME_PATTERNS=

About

Built with

License

GNU GPL v3.0 License

See LICENSE file.