https://github.com/jhu-pl-lab/www-pl-lab
https://github.com/jhu-pl-lab/www-pl-lab
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jhu-pl-lab/www-pl-lab
- Owner: JHU-PL-Lab
- Created: 2024-08-16T15:36:12.000Z (almost 2 years ago)
- Default Branch: source
- Last Pushed: 2024-12-13T15:07:07.000Z (over 1 year ago)
- Last Synced: 2025-01-04T04:34:20.417Z (over 1 year ago)
- Language: Ruby
- Size: 75.7 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The Programming Languages Laboratory website
============================================
Source code for The Programming Languages Laboratory website at
.
Development
-----------
### Basic
Serve the website on your local machine for development.
1. Install [VirtualBox][virtualbox].
2. Install [Vagrant][vagrant].
3. Run:
```console
$ vagrant up
$ vagrant exec docker-compose up jekyll
```
4. Visit .
5. (Optional) To enable auto-reloading features (i.e. changes to source files
are immediately available on the browser) run:
```console
$ vagrant fsnotify
```
Edit the [Markdown][kramdown] files with the contents and the results should
be immediately available for preview by refreshing the browser.
### Run tests
```console
$ vagrant exec docker-compose run --rm jekyll rake test
```
### Install assets dependencies
Assets dependencies (e.g. [jQuery][jquery], [Bootstrap][bootstrap]) are managed
using [Bower][bower], a package manager for the web.
In order to add a dependency, edit `bower.json` and run:
```console
$ vagrant exec docker-compose run --rm bower
```
The packages are installed under `assets/vendor/`.
Deployment
----------
The `source` branch contains the Jekyll source to generated the website, while
the `master` branch contains the generated HTML. This is meant to keep the
deployment scheme used by `pl.cs.jhu.edu`, which consists on serving the
contents of the `master`.
To deploy, run the following from your local machine (not the Vagrant Virtual
Machine nor the Docker container):
```console
$ rake deploy
```
[jekyll]: http://jekyllrb.com
[bower]: http://bower.io/
[jquery]: http://jquery.com/
[kramdown]: http://kramdown.gettalong.org/quickref.html
[bootstrap]: http://getbootstrap.com/
[virtualbox]: https://www.virtualbox.org/
[vagrant]: https://www.vagrantup.com/