This is a landing page for both new and existing FIRST Robotics Competition (FRC) members in the Oceana County Region.
GitHub is "hosting" our static website (powered by Jekyll). All of the files in this "remote repository" (i.e., a folder on GitHub's website) are responsible for producing what you see when you visit: https://oceanarobotics.github.io/OceanaFRC/
.
To get started using this static website-building platform, a few different softwares and dependencies are needed.
VS Code is a professional development environment. This will be installed in a Lab for the programming team. To get ahead of that Lab, please follow these steps:
Go to official Visual Studio Code website using your web browser.
https://code.visualstudio.com/
Download the installer
Run the installer
Launch VS Code
Ruby is an interpreted object-oriented scripting language.
https://rubyinstaller.org/downloads
Jekyll (static website generator) may require extensions which can be compiled using DevKit
https://rubynstaller.org/add-ons/devkit
ruby dk.rb init
ruby dk.rb isntall
With Ruby, we can install Jekyll and Bundler (a Ruby "gem" for managing gem depenencies)
gem install jekyll bundler
Git is tool to interact with GitHub and GitHub's revision control system and funcationality.
https://git-scm.com/download/win
You can either Clone Repository or Create New Jekyll Site from scratch. Instructions for using Jekyll appear below as they are similar for both Windows and macOS. Look for Clone Repository or Create New Jekyll Site.
This will be installed in a Lab for the programming team. To get ahead of that Lab, follow those steps.
Go to official Visual Studio Code website using your web browser.
https://code.visualstudio.com/
Download the macOS version
Open the DMG file
Drag and drop VS Code
Launch VS Code
Note: for future reference, be careful using curl
command. Make sure you know what you are curl'ing.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Git is tool to interact with GitHub and GitHub's revision control system and funcationality.
brew install git
Mac comes with Ruby, but the native Ruby is not useful for us. We need to install a different manager like rbenv.
brew install rbenv
Setup rbenv in your shell by running
rnenv init
Install Ruby using rbenv
Once Ruby is installed using using rbenv, you can now install Bundler and Jekyll.
gem install bundler jekyll
You can either clone an existing repository or create a new Jekyll site from scratch. Instructions for using Jekyll appear below as they are similar for both Windows and macOS. Look for Clone Repository or Create New Jekyll Site.
TBD - Talk with School Technology Directors
Cloning is GitHub's processes of copying a "remote repository" (i.e., files from GitHub's servers) for personal use with a "local repository" (i.e., files on your computer).
mkdir
in command prompthttps://https://github.com/OceanaRobotics/OceanaFRC/
with your web browswerFrom here, there are options:
https://github.com/OceanaRobotics/OceanaFRC.git
linkgit clone https://github.com/OceanaRobotics/OceanaFRC.git
After installing Jekyll, you can create a new Jekyll website (instead of cloning) and start working on it.
Alternative way to create a directory from cmd or Terminal (folder):
mkdir C:\Users\YourUsername\Documents\MyJekyllSite
> enter)mkdir /Users/YourUsername/Desktop/MyNewFolder
Open a command prompt (Windows) or Terminal (macOS) and nagivate to the directory you just created
jekyll new .
Navigate to your Jekyll site's directory (folder) and install the required dependencies:
bundle install
If you are not hosting your Jekyll site on GitHub Pages (which is free to do), you can run your website locally! This is how to develop your website before launching it!
bundle exec jekyll serve
Jekyll framework is now running locally on your computer.
http://127.0.0.1:4000
(i.e., localhost on port 4000)Note: if you want to do development for mobile (i.e., phone, or another device), you can! Follow these steps:
Find the IP address of your laptop or desktop (e.g., 192.168.x.x, 10.x.x.x)
cmd
> enter > type ipconfig
> enter > look for IPv4 for WiFi or Ethernet Terminal
> type ipconfig getifaddr en0
and enter (NOTE: could be en1
instead of en0
)Now, instead of running bundle exec jekyll serve
which will serve at http://127.0.0.1:4000
you enter this to serve for mobile:
bundle exec jekyll serve --host=YOUR_IP_ADDRESS
(e.g., bundle exec jekyll serve --host=192.168.1.25
)On your mobile:
http://YOUR_IP_Address:4000/END_POINT/
(e.g., http://192.168.1.25:4000/OceanaFRC/
)/
You are now serving a development server on your main device that you are accessing from another device on the same network ("ad hoc").
To host your website, you can use GitHub Pages. This requires you to make a GitHub account (or I will let you use the Team's account). Big ideas here:
gh-pages
Visit https://jekyllrb.com/
or email [email protected]
with a description of the problem, and any errors or screenshots you have.