webOS OSE website (WIP)

Welcome to the webOSE OSE website project! This is a work-in-progress effort for reimplementing the webosose.org site.

Contents

• Overview
• Getting started
• Directory structure

Overview

We aim at transforming the site based on static site generator and modern hosting tools.

Dependencies

This project is built upon the following tools and libraries.

• Static site generator: Hugo (extended)
• CSS framework: Bulma
• JS library: jQuery

Hugo

Hugo is a static site generator written in Go.

This project uses a directory structure that requires Hugo's asset processing feature called Hugo Pipes. To build the project, you need an extended version of Hugo. For more information, refer to the links below:

• Hugo extended version (from v0.43 and higher)
• Hugo Pipes introduction

Bulma

Bulma is a free, open source CSS framework based on Flexbox.

jQuery

jQuery is a fast, small, and feature-rich JavaScript library.

Getting started

Note: We will assume that you are using Windows.

Installing tools

To build and test the project in your local environment, install the following tools:

• Git
• Hugo extended version

Git

Download and install the latest version of Git from the official site, using the default setting.

Hugo extended version

In the Hugo releases page, download an extended version of Hugo (with the name in hugo_extended_0.**_***-64bit.*** format) and install the package.

Note: This site has been tested with the extended version of Hugo v0.53. Netlify has issues with fetching v0.54, so we recommend that you use v0.53 to sync up the environment.

For details on setup, you can refer to the following section for details:

• https://gohugo.io/getting-started/installing/#windows

Preparing the code

1. Create your project directory (e.g. C:\Hugo\Sites\sampleSite) and cd into the directory.
2. Clone this repository.

git clone [repository name]

Previewing the site

1. At the project root directory, enter the following command:

hugo server

2. When the build is completed, enter the address (localhost:[port number]) shown at the prompt into the browser address bar.

Locally built site will be displayed on the browser.

Directory structure

TODO