Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 4.07 KB

README.md

File metadata and controls

98 lines (68 loc) · 4.07 KB
Raw

Teach LA Website

Test Jekyll Build Site Up Status Netlify Status

Heya there, this is ACM Teach LA's website! It's goal is to give Teach LA a more formal online presence, and to create a one-stop shop for prospective tutors and schools to get more information about us!

This website is built with Jekyll, with some component implementations taken from ACM's main website (conforming to ACM Design's Style Guide). We build and test this website with GitHub Actions, and deploy it on Netlify. We will be running on ruby 3.2.5 and jekyll 4.3.3

Development Setup

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, let's clone our project with git, and install our dependencies!

$ git clone https://github.com/uclaacm/teach-la-website.git
$ cd teach-la-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/matt/code/tla/static/_config.yml
            Source: /Users/matt/code/tla/static
       Destination: /Users/matt/code/tla/static/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.17 seconds.
 Auto-regeneration: enabled for '/Users/matt/code/tla/static'
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

If these steps do not work for you, you may also try doing this:

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!

Contribution Workflow

Want to make a change to the website? Great! Here are the steps:

  1. Either make a new branch or a fork of this repository. master is a protected branch, so you cannot push to it.
  2. Follow the instructions in "Development Setup" above. If you're on a fork, replace the URL with the fork's URL; if you're on a different branch, check it out using git checkout.
  3. Make your changes!
  4. Before you push, make sure your app builds with bundle exec jekyll build. If there are any errors, our CI/CD service will reject your build.
  5. Once you're ready, stage and commit your changes!
  6. Make a pull request with your changes, and let someone on the dev team know.
  7. If your code passes code review, we'll merge it into master. Congratulations! If you'd like, it's now safe to delete your branch/fork.

Adding Yourself to the Teams Page

Moved to here.

Troubleshooting tips:

  1. run gem install bundler
  • if doesnt work try to sudo
  1. install homebrew. This way we can manage ruby version conflicts
  2. run ruby -v. You want to be on version 3.2.5 (REALLY IMPORTANT)
  3. run
brew install rbenv
brew install ruby-build
rbenv init
rbenv install 3.2.5
rbenv global 3.2.4
gem update jekyll
gem update bundler
bundle install 
bundle update

** note: may need to sudo if you do not have permission I hope this helps