Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 4.76 KB

README.md

File metadata and controls

51 lines (38 loc) · 4.76 KB
Raw

awalkaday.art Photography Collection

This is the code repository of a web gallery, mainly built in JavaScript, that is used to exhibit a digital photo collection.

website overview screenshot

Highlights

  1. Easy setup and lightweight web gallery.
  2. No complex code changes required.
  3. Responsive & fast display for various devices.

Quick Start

If you have basic knowledge of web development, then this open-source project may help you set up a web application to showcase all your visual creations without much effort.

Follow the steps below and your site will be live in no time:

  1. Fork this repo by clicking the Fork button at the top right corner.
  2. Enable GitHub Pages in the code repository settings.
  3. Upload your pictures to the images directory. (You may do that via GitHub.com or clone/push the images to your repo.)
  4. Add your own web domain in the CNAME file or just delete the file if you don't own a domain in order to use the default domain that GitHub provides.
  5. Update the baseurl field inside _config.yml with the web domain used in step #4.
  6. And that's it, your web app is set and ready. To view the results, visit the link configured in the CNAME file. In this particular case, the web address is awalkaday.art.

It is possible to modify the short site description shown on the front-page's bottom area by editing the _config.yml file.
Site navigation pointers, such as social media icons, contact methods, external links, license documents, legal statements, ... are located in the footer section.

website footer screenshot

Deployment Guide

The essential tool required to build the website is an NPM package: gulp which is used to automate image resizing and thumbnail generation.

Do the following before you push your images to a remote code repository:

  1. Fork and then, clone the project to your computer.
  2. Go inside the project's root folder $ cd awalkaday.
  3. Install all Node Package Manager (npm) dependencies by running $ npm install. This step will take some time required to download and install recent versions of NodeJS, ImageMagick, Git, Python, Build Tools for your IDE like Node.js for Visual Studio and other specified dependencies.
  4. Copy all your photographs (if possible: in JPG file format, of the largest size available, straight from your camera memory card) and place them inside the images directory.
  5. Run $ gulp on the command line inside the git folder in order to resize the images and generate thumbnails.
  6. Add your local code changes to a remote server by using $ git add --all then, follow up with a signed commit $ git commit -S -m "a short and descriptive commit message" and lastly, update your remote code repo with the command $ git push origin master.

Credits

Forked from: rampatra/photography — Enhanced for Jekyll by Ram Patra — Code reused under GPL-3.0 License.
Template: Multiverse by HTML5 UP — Web designer and developer: ajlkn.
Fonts: Source Sans 3 — Used under: SIL Open Font License.
Icons made from: OpenMoji — Remixed under CC BY-SA 4.0.

Copyrights

Code Open-source License: European Union Public License 1.2.
Content Legal Rights: Attribution-NonCommercial-NoDerivs 4.0 International (CC BY-NC-ND 4.0).
Website Owner & Developer: Chris-Armel (@daqhris).

website logo