Skip to content

Commit

Permalink
Added a README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
netsgnut committed Mar 3, 2016
1 parent 3680ac9 commit 0f8d892
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
@@ -0,0 +1,32 @@
[Repository for hkatv.rip](http://github.com/netsgnut/hkatv.rip)

## About

This repository stores the deployed version of [this website](http://hkatv.rip/).

Made with love by [@siuying](http://github.com/siuying) and [@netsgnut](http://github.com/netsgnut).

## How to Deploy?

Currently the website is hosted on [S3](http://aws.amazon.com/s3/) as a static website. One can copy all the files in `public/` to the root of the bucket and start rocking.

Alternatively one can also use the deploy script. It is written in Ruby and assumes [Bundler](http://bundler.io/) and [Rake](https://github.com/ruby/rake) are properly installed and configured.

The necessary dependencies are installed by:

```bash
bundle install
```

Place a `credentials.json` file and put it aside on the same directory with this readme. It should contain `AccessKeyId` and `SecretAccessKey`. Make sure this credential has write permission on the bucket specified at the Rakefile.

Uploading then is all about:

```bash
rake deploy
```

# History

(Some sentimental short paragraphs here... sometime maybe?)

0 comments on commit 0f8d892

Please sign in to comment.