{"id":13565147,"url":"https://github.com/writeas/htmlhouse","last_synced_at":"2025-08-20T12:10:40.870Z","repository":{"id":57562141,"uuid":"44928557","full_name":"writeas/htmlhouse","owner":"writeas","description":"⌂ Publish HTML quickly / 🐴 Develop a WriteFreely theme","archived":false,"fork":false,"pushed_at":"2021-06-04T20:19:37.000Z","size":854,"stargazers_count":100,"open_issues_count":3,"forks_count":24,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-09T02:12:19.428Z","etag":null,"topics":["css","html","privacy","web-application","website-builder","writefreely"],"latest_commit_sha":null,"homepage":"https://html.house","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/writeas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-25T20:35:20.000Z","updated_at":"2025-02-16T13:56:27.000Z","dependencies_parsed_at":"2022-09-16T13:30:51.088Z","dependency_job_id":null,"html_url":"https://github.com/writeas/htmlhouse","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writeas%2Fhtmlhouse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writeas%2Fhtmlhouse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writeas%2Fhtmlhouse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writeas%2Fhtmlhouse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/writeas","download_url":"https://codeload.github.com/writeas/htmlhouse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252542523,"owners_count":21764984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css","html","privacy","web-application","website-builder","writefreely"],"created_at":"2024-08-01T13:01:41.726Z","updated_at":"2025-05-05T17:33:19.210Z","avatar_url":"https://github.com/writeas.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"⌂ HTMLhouse / 🐴 CSShorse\n=========\n\n⌂ Publish HTML quickly / 🐴 Develop a WriteFreely theme\n\n[![HTMLhouse screenshot](https://i.snap.as/Pjfv63IO.png)](https://html.house)\n[![HTMLhouse screenshot](https://i.snap.as/5sJLTmFV.png)](https://css.horse)\n\nHTMLhouse uses [ACE editor](https://ace.c9.io/) for modifying HTML and shows a live preview of what you've created in an `iframe` alongside the source code.\n\nNo user signup is required -- authorization to modify an individual published page is saved on the creator's device in local storage as an ID and [JWT](http://jwt.io/) generated by the server.\n\nIt is also available as an [Android](https://play.google.com/store/apps/details?id=com.abunchtell.htmlhouse) app.\n\n## Development\n\n### Requirements\n\n* Go\n* Node.js\n* MySQL\n\n### Setup\n\n1. Clone the repo\n2. Run `go get -d` to get necessary dependencies\n3. Run `make install` to install LESS compiler locally and generate the CSS files\n4. Run the queries in `init.sql` to set up the database\n5. _Optional_. Run `./keys.sh prod` to create a new keypair\n\n### Running the server\n\n* Run `go run cmd/htmlhouse/main.go` in the top level directory, optionally by creating a simple run script\n```bash\n#!/bin/bash\n\nDB_USER=dbuser DB_PASSWORD=pass DB_DB=htmlhouse PRIVATE_KEY=keys/dev PUBLIC_KEY=keys/dev.pub go run main/main.go\n```\n* Open your browser to http://localhost:8080\n\n#### Environment Variables\n\n| Variable | What it is | Default value |\n| -------- | ---------- | ------------- |\n| `DB_USER` | Database user | None. **Required** |\n| `DB_PASSWORD` | Database password | None. **Required** |\n| `DB_DB` | Database name | None. **Required** |\n| `DB_HOST` | Database host | `localhost` |\n| `PRIVATE_KEY` | Generated private key | None. **Required** |\n| `PUBLIC_KEY` | Generated public key | None. **Required** |\n| `PORT` | Port to run app on | `8080` |\n| `STATIC_DIR` | Relative dir where static files are stored | `static` |\n| `ALLOW_PUBLISH` | Allow users to publish posts | true |\n| `AUTO_APPROVE` | Automatically approves public posts | false |\n| `PREVIEWS_HOST` | Fully-qualified URL (without trailing slash) of screenshot server | None. |\n| `ADMIN_PASS` | Password to perform admin functions via API | `uhoh` |\n| `BROWSE_ITEMS` | Number of items to show on Browse page | 10 |\n| `BLACKLIST_TERMS` | Comma-separated list of terms to prevent a post from being made public | None. |\n| `TWITTER_KEY` | Twitter consumer key | `notreal` |\n| `TWITTER_SECRET` | Twitter consumer secret | `notreal` |\n| `TWITTER_TOKEN` | Twitter access token of the posting Twitter account | `notreal` |\n| `TWITTER_TOKEN_SECRET` | Twitter access token secret of the posting Twitter account | `notreal` |\n| `WF_MODE` | Run CSShorse, not HTMLhouse — for customizing WriteFreely blogs | `false` |\n\n### Notes\n\n**Changing CSS**. Run `make` after all changes to update the stylesheets.\n\n**When you don't need to reload the app**. When you make changes to any files in `static/` you can simply refresh the resource without restarting the app.\n\n**When to reload the app**. If you change any of the templates in `templates/` or any `.go` file, you'll need to re-run the app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwriteas%2Fhtmlhouse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwriteas%2Fhtmlhouse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwriteas%2Fhtmlhouse/lists"}