Commit a408c724 authored by Guus Hoekman's avatar Guus Hoekman

update readme to explain how to run locally

parent fe2e5481
Pipeline #87394429 passed with stage
in 1 minute and 30 seconds
......@@ -27,12 +27,8 @@ GEM
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-feed (0.11.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.5.0)
jekyll (~> 3.3)
jekyll-watch (2.1.2)
listen (~> 3.0)
kramdown (1.17.0)
......@@ -42,10 +38,6 @@ GEM
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
minima (2.5.0)
jekyll (~> 3.5)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (3.0.3)
......@@ -66,9 +58,6 @@ PLATFORMS
DEPENDENCIES
jekyll (~> 3.8.5)
jekyll-feed (~> 0.6)
minima (~> 2.0)
tzinfo-data
BUNDLED WITH
1.16.6
......@@ -2,6 +2,21 @@
An alternative way to display the traditional league table | [canntables.com](https://canntables.com)
## Run it locally
Running Cann Tables locally is pretty easy. It uses [Jekyll](https://jekyllrb.com/) to generate the site.
This short guide assumes that you have both [Ruby](https://www.ruby-lang.org/en/downloads/) and [RubyGems](https://rubygems.org/pages/download) installed. If you do not have Ruby and RubyGems installed, do that first.
1. Clone the repository
2. Install [`bundler`](https://bundler.io/), a gem manager, using `gem install bundler`
3. Go the the project's directory: `cd cann-tables`
4. Install the project's required gems by running `bundle install`
5. Use Jekyll to generate the page `bundle exec jekyll serve`
6. The site should be available at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/)
## Let's Encrypt
This is now done automatically by GitLab, but just in case here's the command to do it manually:
`sudo letsencrypt certonly -d canntables.com --manual`
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment