HouseLearning Docs

Getting Started

Installation Guide: Setting Up for Local Development

Since HouseLearning is built on **static files** hosted via GitHub Pages (keeping the project free and simple), the setup process is minimal. You don't need databases, complex servers, or special frameworks—just the files and a browser!

1. Prerequisites

Ensure you have these two essential tools installed:

  • Git: Used for cloning the repository and managing contributions.
  • Text Editor: Any code editor (VS Code, Sublime Text, Atom) for modifying HTML and Markdown files.

2. Clone the Repository

Open your terminal or command prompt and run the following command to download the entire project structure:

git clone https://github.com/houselearning/houselearning.github.io.git

This will create a new directory named houselearning.github.io containing all the documentation files.

3. View the Documentation

You have two easy, zero-cost methods to view and test the documentation locally:

Method A: Direct File Open (Recommended for simple viewing)

  1. Navigate into the cloned directory: cd houselearning.github.io
  2. Locate the main file: index.html
  3. Right-click index.html and select "Open with" → "Your Browser" (e.g., Chrome, Firefox).

Note: Some browser features (like dynamic URL routing) may not function perfectly using this method, but it is great for content editing.

Method B: Simple HTTP Server (Recommended for full functionality)

If you have Python installed, you can use its built-in server to simulate a web host locally:

python3 -m http.server

After running the command, open your browser and navigate to: http://localhost:8000

What's next?

Now that you have the documentation running, proceed to the Configuration guide to learn how to prepare your local environment for making and submitting changes.

Continue to Configuration →