OurTransfi

The home page of the Transfiguration of Christ Parish. http://www.ourtransfi.org

The parish website works as a fully-static web project with no serviceable web service components, intended for deployment on cheap static hosting and content that doesn't need dynamic updates.

NOTE: This repository is old (since 2015/2016) and may encounter issues when running in newer environments.

Pre-requisites and Libraries

• Jekyll - used for compiling and building the site
• jQuery - as per usual
• Bootstrap - for UI, responsiveness and layouts
• AWS CLI - for quick deployment on Amazon S3, but is not necessary.

Quick Start

• Clone this repository.
• Load up Jekyll to build or serve (display locally) the site.

# Go to the Home directory where all site assets are kept
cd Home

# Build using Jekyll
docker run --rm \
  --volume="$PWD:/srv/jekyll" \
  -it jekyll/builder:3.8 \
  jekyll build

# ...or Serve using Jekyll
docker run --rm \
  --volume="$PWD:/srv/jekyll" \
  -p 80:4000 \
  -it jekyll/builder:3.8 \
  jekyll serve

Alternately...

# ..or run a Ruby setup...
gem install --user-install bundler jekyll html-proofer

# then run...
cd ourtransfi
./_scripts/build.sh

**NOTE: All text beyond this point was written a long time ago (2015)

Development

You will need a proper Jekyll setup for development, along with its requirements. Jekyll is used to compile and generate Markdown and HTML + Templates into a proper static website ready for deployment.

Please read the Jekyll documents at http://www.jekyllrb.com

You can preview OurTransfi by simply executing jekyll serve on the Home directory.

Please observe proper Jekyll templating markup. Use Markdown when necessary, followed by HTML and appropriate templating references.

Deployment

OurTransfi can easily be deployed in any web server, or any service as a platform that allows static and/or dynamic content for its web servers. jekyll serve on its own is already functional for other users to view, provided that the machine is exposed to the internet.

You can either use that or any of your favorite web server applications.

By default, OurTransfi is hosted on Amazon's widely-available, affordable and speedy Simple Storage Service.

• Just configure Amazon CLI, apply the right key configuration for deploying onto your own account. Run jekyll build then run sync.sh and it should deploy all new changes to the provided address in sync.sh

• The repository also includes the files needed to have the project deployed through Travis. Simply supply the needed keys for AWS in your own setup and Travis should deploy the project on your S3 bucket whenever pull requests or changes are added onto the master branch.

License

In terms of code content specific to the project (excluding third-party libraries, embedded content, image assets, written content and others), OurTransfi itself is licensed under the GNU AGPLv3.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.