Welcome to the LearnTeachCode Code & Coffee Compendium Github Repository! Maintained by the Code & Coffee Office Hours 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 (PR) 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.
-
Docker
-
Git (for contributors, quicker access to the repository source code)
-
A Bash terminal (standard terminal environment for *nix and macOS).
|
ℹ️
|
To Windows users: Windows Command Prompt will not satisfy this dependency. Instead, you can use PowerShell or another Bash terminal (like Git Bash for example). |
|
🔥
|
Please make sure you have all required dependencies before continuing. |
There may be situations where you want to view the site locally through a local web server. In this case, you should run serve.sh. For example, type the following command in the project directory:
-
Clone or download this repository to your machine.
-
Open a terminal window. Change your current directory to the cloned project directory.
-
Using a Bash terminal, type the following command to update all dependent submodules:
git submodule update --init --recursive-
Next, type the following command:
sh serve.sh|
ℹ️
|
If you receive a permissions error on *nix or macOS, prepend sudo to the command. For example, type the following command: |
sudo sh serve.shAfter running the serve.sh script, you can access the site through your web browser through this URL: http://localhost:1313/code-coffee-compendium/home
You can stop the local web server by pressing CTRL + C in the Bash terminal where you ran the serve.sh script.