The Penta Global Blockchain Foundation website built with Hugo, NodeJS and Gulp
'Penta' or 'PNT', short for Penta Network, is a next generation blockchain platform for both public and private projects. With an emphasis on contributing to the real economy, Penta is building the world’s most inclusive, equitable, and decentralized blockchain community.These instructions will get you a copy of the website project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
For development and to build the Penta website, you will need Hugo, Node and Gulp installed on your environement. What follows are installation notes from the respective readme's.
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. As an asynchronous event driven JavaScript runtime, Node is designed to build scalable network applications.
- Automation - gulp is a toolkit that helps you automate painful or time-consuming tasks in your development workflow.
- Platform-agnostic - Integrations are built into all major IDEs and people are using gulp with PHP, .NET, Node.js, Java, and other platforms.
- Strong Ecosystem - Use npm modules to do anything you want + over 2000 curated plugins for streaming file transformations
- Simple - By providing only a minimal API surface, gulp is easy to learn and simple to use
Hugo is a static HTML and CSS website generator written in Go. It is optimized for speed, ease of use, and configurability. Hugo takes a directory with content and templates and renders them into a full HTML website.
Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory. This works well for shared hosts and other systems where you don’t have a privileged account.
Hugo renders a typical website of moderate size in a fraction of a second. A good rule of thumb is that each piece of content renders in around 1 millisecond.
Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.
Why Hugo? Good question, and one that is answered in this article. The upshot is that for many websites, including for Penta, a database backed system, or one hosted by a service like WordPress is too much technology for the job at hand. For our site we wanted to:
- deliver our message of what Penta Global is building for blockchain in a clear way
- provide an up to date blog of our activities and announcements that is easy to manage
- separate site maintenance and content so our teams around the world could contribute without expertise with the underlying html (separation of concerns)
- host a very fast loading site on any device, our users should be happy reading about Penta and not 'bloated'
Node is easy to install and includes NPM. You should be able to run the following terminal command after the installation procedure below.
$ node --version
v0.10.24
$ npm --version
1.3.21
You will need to use a Terminal. On OS X, you can find the default terminal in
/Applications/Utilities/Terminal.app.
Please install Homebrew if it's not already done with the following command.
$ ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
If everything when fine, you should run
brew install node
sudo apt-get install python-software-properties
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs
Just go on official Node.js website & grab the installer.
Also, be sure to have git available in your PATH, npm might need it.
$ git clone https://github.com/ORG/PROJECT.git
$ cd PROJECT
$ npm install
There are a few ways to install:
- gulp v4.0.0 -
npm install gulp@next - gulp v4.0.0-alpha.3 -
npm install gulpjs/gulp#v4.0.0-alpha.3 - gulp v3.9.1 -
npm install gulp
To use Hugo as your site generator, simply install the Hugo binaries. They have no external dependencies.
To contribute to the Hugo source code or documentation, you should fork the Hugo GitHub project and clone it to your local machine.
Finally, you can install the Hugo source code with go, build the binaries yourself, and run Hugo that way.
Building the binaries is an easy task for an experienced go getter.
Use the installation instructions in the Hugo documentation.
Since Hugo 0.48, Hugo uses the Go Modules support built into Go 1.11 to build. The easiest is is to clone Hugo in a directory outside of GOPATH, as in the following example:
mkdir $HOME/src
cd $HOME/src
git clone https://github.com/gohugoio/hugo.git
cd hugo
go installIf you are a Windows user, substitute the $HOME environment variable above with %USERPROFILE%.
Before anything else, the required nodejs dependencies need to be installed using the npm package manager:
$ sudo npm install
The Hugo documentation has everything you need for working with the generator. A single terminal command rebuilds the Penta site from source (without optimization):
$ hugo
If you are feeling unstatisfied and really feel it should take longer than a couple of seconds to generate the complete Penta website, here is an article about Hugo that can help fill in some time with reading. But, if you are like us, we want to quickly get you on your way to building awesome blockchain DAPPS using the Penta platform.
Gulp tasks are used to post-process the website build for optimization and deployment. The default task to optimize everything:
$ gulp
A live-reloading local webserver on port 8000 is available for local testing and site preview with a gulp task:
$ gulp server
It is recommended that one terminal session is used for site rebuilds and a second session to launch the webserver.
Add additional notes about how to deploy this on a live system
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc