README.md

SocialHackDay

This is a source code for the front end web service of SocialHackDay

Features

• Unify theme (version 4) which is compiled by Middleman

Requirements

• Middleman 4.x
• Ruby 2.x
• Node 6.x
• Gulp CLI

Setup

Please see SETUP.md If you use Docker, please see README.docker.md

Environments

There are two types of way to see the HTML.

1. server mode If you run bundle exec middleman server at root, you will see compiled HTML files in your browser. It will track source modifications and reload the browser automatically.

2. build mode If you run bundle exec middleman build at root, you will find compiled HTML files in ./build directory.

DataSource

Please edit this sheet

Deployment

Updating master branch will automatically deploy them to the production server.

Do not directly commit to those branches. Use pull requests

see DEPLOY.md for more details

Development

(1) SETUP environment (2) Create new branch (3) Modify sources in the source directory.

directory structure

Directories	Usage
Gemfile	gems
Gemfile.lock	gems' version
bin	setup comannd
build	html files will be created after build
config.rb	middleman setting
data	data folder for middleman
environments	settings for environments
gulpfile.js	used in build phase
helpers	middleman helpers
lib	libraries copied from Unify theme
node_modules	will be created by node install
package.json	node modules
package-lock.json	node modules' versions
source	source folder
spec	middleman spec (don't use)
vendor	will be created after bundle install

(4) Run bundle exec middleman start Check changes via launched browser.

(5) Commit and push the branch to this repository.

(6) Send a pull request.