cotech-website/README.md

46 lines
1.5 KiB
Markdown
Raw Normal View History

2017-07-03 10:28:43 +00:00
# CoTech Website
## Introduction
This is a port of the current Wordpress version of the [CoTech Website][] to a statically-generated site using [Jekyll][].
2017-07-03 10:28:43 +00:00
## Run the site locally
2017-07-03 10:28:43 +00:00
You can run the site on your computer as if it were live online using Jekyll. You will need `git` and `ruby` installed on your machine to do this. Then clone the repository
2017-07-03 10:28:43 +00:00
git clone git@git.coop:cotech/website.git
2018-11-30 11:45:48 +00:00
### ... using docker
Make sure you have [docker](https://docs.docker.com/install/) (CE is fine) installed and running, then:
cd website
./dev
And visit [localhost:4000](http://localhost:4000) to view the site.
### ... directly on your machine
2017-07-03 10:28:43 +00:00
Install the dependencies for the project
2017-07-03 10:28:43 +00:00
cd website
gem install bundler
bundle install
2017-07-03 10:28:43 +00:00
Run a local web server so that you can view the site
2017-07-03 10:28:43 +00:00
bundle exec jekyll server
2017-07-03 10:28:43 +00:00
And visit [localhost:4000](http://localhost:4000) to view the site.
2018-11-18 15:25:52 +00:00
## Deploy CI
2018-11-29 14:53:51 +00:00
When changes are committed to the `master` branch the `.gitlab-ci.yml` file triggers the building of the site and then the copying of the results to https://static.coops.tech/ and when changes are committed to the `dev` branch the site at https://dev.static.coops.tech/ is updated.
2018-11-18 15:25:52 +00:00
## Contributing
There's a [list of bugs and improvements](https://git.coop/cotech/website/issues) in the repository. Feel free to add more, discuss or claim any of these issues to work on.
2017-07-03 10:28:43 +00:00
[CoTech Website]: https://www.coops.tech/
[Jekyll]: https://jekyllrb.com/