Welcome to the LearnTeachCode Code & Coffee Compendium Github Repository! Maintained by the Baldwin Park & El Sereno/Alhambra study group, this repository hosts the source code for code-coffee-compendium resource site.
This site was generated using Asciidoctor - a static-site generator for the AsciiDoc markup language.
Want extra coding help? Join our Slack group.
Contributors are welcome to fork this repository and make changes. Please submit a Pull Request with your changes to be reviewed by a repository owner.
Not sure where to start? There are a number of issues that you can work on. Find them here.
This project has a number of dependencies that must be met before running on your machine.
-
Download Ruby 2.4+
-
Clone or download this repository to your machine.
-
Open a terminal window. Change your current directory to the cloned project directory.
-
Install the package bundle by running the following command in the terminal window:
gem install bundler:2.1.4 bundle install
This project also uses PlantUML to generate diagrams. Download PlantUML here.
|
ℹ️
|
In addition to PlantUML, you will need GraphViz to display the sitemap diagram. Download GraphViz here. |
|
🔥
|
Please make sure you have all required dependencies before continuing. |
-
Clone or download this repository to your machine.
-
Open a terminal window. Change your current directory to the cloned project directory.
-
Inside of your terminal, type the following command:
ruby convert.rb
|
ℹ️
|
The convert.rb script will convert the .adoc files inside of the project directory into .html files that can be viewed in a web brower. You may see a few warnings appear in the terminal window after running this script. In most cases, it’s fine to ignore them. If you have a concern, please submit an issue. |
Double-click on the index.html file that was generated in the project directory to view the site in a web browser.