Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.05 KB

README.md

File metadata and controls

85 lines (57 loc) · 3.05 KB
Raw

BSI Website

Soon to be renamed to BSI!

Netlify Status

BEAM (Building Engineers and Mentors @ UCLA) is a service club at UCLA that brings hands-on science activities to underserved K-8 schools across Los Angeles. This repository holds the code for our simple website, which hosts logistics information and our lesson plans.

Development Setup

Making your own changes is easy! This website uses Jekyll, a ruby-based static site generator, to do lots of the boring work - that way, you can focus on changing the content!

To get a copy of this website running locally on your machine, you'll need Ruby, a copy of this repo, and access to your system's shell/terminal.

Note: we recommend using rvm instead of your system ruby; it makes life easier 😄!

First, let's install Bundler, a gem environment manager for ruby. Type this anywhere in your shell:

$ gem install bundler
...

Then, we can clone our project and install its dependencies.

$ git clone https://github.com/mattxwang/beam-website.git
...
$ cd beam-website
$ bundle
...

This should install all of our RubyGems dependencies! Note that we've committed a Gemfile.lock, so you should get a working set of gems.

Finally, run:

$ bundle exec jekyll serve
Configuration file: /Users/mattxwang/code/beam-website/_config.yml
            Source: /Users/mattxwang/code/beam-website
       Destination: /Users/mattxwang/code/beam-website/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.348 seconds.
 Auto-regeneration: enabled for '/Users/mattxwang/code/beam-website'
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

Visit whatever follows the server address line in your browser, which is usually http://127.0.0.1:4000/.

If you run into any issues, please let us know on our issues tracker.

How to Use

NOTE: GitHub Actions is required to deploy to GitHub Pages because GitHub refuses to update their version of Jekyll.

Credits

This Jekyll theme was made by Andrew Banchich, based on the Forty theme by HTML5 UP. The original repo is found here: https://github.com/andrewbanchich/forty-jekyll-theme

Original Credits from HTML5 UP:


Credits:

	Icons:
		Font Awesome (fortawesome.github.com/Font-Awesome)

	Other:
		jQuery (jquery.com)
		html5shiv.js (@afarkas @jdalton @jon_neal @rem)
		background-size polyfill (github.com/louisremi)
		Misc. Sass functions (@HugoGiraudel)
		Respond.js (j.mp/respondjs)
		Skel (skel.io)

Repository Jekyll logo icon licensed under a Creative Commons Attribution 4.0 Intb;;ernational License. b;;