Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.24 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.24 KB

Stack logo

The Stack

Daily Bruin's data journalism and newsroom tech blog.

Installation (Mac/Linux)

  1. clone repository: git clone https://github.com/dailybruin/the-stack.git
  2. cd into the newly created directory
  3. run ./setup.sh
  4. run jekyll serve

Troubleshooting

  • If you get dependency errors, try gem installing them.
  • If you still get dependency errors, look for a Gemfile.lock file in the top level of the local repo, delete it, and re-run jekyll serve.

Installation (Windows)

Follow these instructions. When given the choice, install Rouge instead of Pygments for syntax highlighting. Here are some other considerations when using Jekyll on Windows.

Alternatively, use a VM:

  1. Download VirtualBox
  2. Grab a copy of the latest version of Ubuntu Server.
  3. Install the Ubuntu Server ISO in a VirtualBox VM.
  4. Configure VirtualBox port forwarding from VM port 4000 to host port 4000.
  5. Follow the instructions for Mac installation above.

Contributing

TL;DR

  1. Develop on your own feature branch. Only the data editor should commit to master.
  2. Follow the coding practices outlined in the docs and the conventions established in existing posts.

Pull requests which do not conform to the above will not be accepted. If you have any questions on how something should be done, please ask the data editor.

Project reports

When you finish a project, write up a small report in docs/project-reports/year and link it here! Project reports should have basic information on the tools you used when creating your project, and any information that would help out someone who is trying to do something similar! Be sure to add a link to your branch in the report for our reference or for professional reference!

Find old project reports here! 2020

Stack swag