code-coffee-compendium

code-coffee-compendium copied to clipboard

ifdef::env-github[] :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavy_exclamation_mark: :caution-caption: :fire: :warning-caption: :warning: endif::[]

== code-coffee-compendium image:https://img.shields.io/badge/License-MIT-yellow.svg[MIT License, link=https://opensource.org/licenses/MIT] image:https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square[PRs Welcome, link=http://makeapullrequest.com] image:https://img.shields.io/badge/View%20on-GitHub-orange[View on GitHub, link=https://github.com/LearnTeachCode/code-coffee-compendium/]

https://learnteachcode.org/code-coffee-compendium/home/

== Introduction 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 https://learnteachcode.org/code-coffee-compendium/[code-coffee-compendium] resource site.

This site was generated using https://asciidoctor.org/[Asciidoctor] - a static-site generator for the https://asciidoctor.org/docs/asciidoc-syntax-quick-reference[AsciiDoc] markup language.

Want extra coding help? Join our https://learnteachcode.org/slack[Slack group].

== Contributing 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. https://github.com/LearnTeachCode/code-coffee-compendium/issues/[Find them here.]

== Dependencies This project has a number of dependencies that must be met before running on your machine.

1. Docker
2. Git (for contributors, quicker access to the repository source code)
3. A Bash terminal (standard terminal environment for *nix and macOS).

NOTE: 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).

== Viewing the site through a local web server CAUTION: 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:

[source] git submodule update --init --recursive

[start=4] . Next, type the following command:

[source] sh serve.sh

NOTE: If you receive a permissions error on *nix or macOS, prepend sudo to the command. For example, type the following command:

[source] sudo sh serve.sh

After 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.