Website for the Georgia Tech Visualization Lab, deployed at https://vis.gatech.edu
- Install Jekyll and dependencies.
- For Windows users: we recommend installing [email protected] (https://rubyinstaller.org/downloads/) to avoid the dependency problem between Jekyll and Ruby (For more information: https://talk.jekyllrb.com/t/liquid-4-0-3-tainted/7946).
- Install Node.js and npm (tested on node v18, npm v10).
- Install npm-based packages using
npm install
. - Install bundles:
bundle install
. - Compile and serve the app using
bundle exec jekyll serve --livereload
. - Open browser to http://localhost:4000.
If you are unfamiliar with forking and submitting pull requests, here is a 4-minute guide to get you started.
- Fork this repository.
- Make your edits on the
main
branch of the forked repository and commit them. - Submit a Pull Request on the original (non-forked) repository, from your forked repository's
main
branch to the original repository'smain
branch, and an admin will merge it.
** Only for an admin **
- For each successful push to the
main
branch, Github will automatically start a workflow (via Github Actions) and compile the source into thebuild
branch. If something is going wrong here or if something needs to be changed here, edit .github/workflows/github-pages.yml. - Verify the build through a green checkmark next to the commit message / workflow AND by actually going to the
build
branch to see fresh commits (sometimes, the workflow does not automatically push these commits, which is weird.). Depending on what goes wrong, eitherRe-run all jobs
or debug your code by following the error log. - To deploy the code in the
build
branch to vis.gatech.edu, first login to the GT VPN. - Go to hosting.gatech.edu > My Plesk Hosting > vis.gatech.edu (you must be an admin to see these -- reach out to core faculty if you must.)
- Under 'My Sites' click on
vis.gatech.edu
. - Under Dev Tools' click on
Git
>Pull now
- Verify by opening vis.gatech.edu in a browser (in cognito window to be absolutely sure).
- All set!
- gtvislab [at] gmail [dot] com