Publish HTML quickly. https://html.house

Matt Baer b077f425a1 Add contributing guidelines		6年前
keys	Add backend ability to save/get a house	8年前
main	Move import path to writeas/htmlhouse	8年前
static	Self-host jQuery	6年前
templates	Self-host jQuery	6年前
.gitignore	Add package build script	7年前
CONTRIBUTING.md	Add contributing guidelines	6年前
INSTALL	Add install instructions	7年前
README.md	Add IRC badge to README	8年前
app.go	Add public houses endpoint	8年前
build.sh	Add install instructions	7年前
config.go	Support posting new public houses to Twitter	8年前
construction.go	Return stats with public houses	8年前
database.go	Add backend ability to save/get a house	8年前
house.go	Add backend ability to save/get a house	8年前
init.sql	Support posting new public houses to Twitter	8年前
keys.sh	Prevent running keys.sh with no params	8年前
makefile	Correctly generate keys on `make install`	7年前
models.go	Return stats with public houses	8年前
session.go	Fix session to work with jwt-go library v3	7年前
templates.go	Add Browse page	8年前
twitter.go	Skip tweeting pages with "HTMLhouse" title	8年前

README.md

HTMLhouse

Publish HTML quickly.

HTMLhouse uses ACE editor for modifying HTML and shows a live preview of what you’ve created in an iframe alongside the source code.

No 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 generated by the server.

It is also available as a Chrome extension and browsable on Android.

Development

Requirements

Go
Node.js
MySQL

Setup

Clone the repo
Run go get -d to get necessary dependencies
Run make install to install LESS compiler locally and generate the CSS files
Run the queries in init.sql to set up the database
Optional. Run ./keys.sh prod to create a new keypair

Running the server

Run go run main/main.go in the top level directory, optionally by creating a simple run script

#!/bin/bash

DB_USER=dbuser DB_PASSWORD=pass DB_DB=htmlhouse PRIVATE_KEY=keys/dev PUBLIC_KEY=keys/dev.pub go run main/main.go

Open your browser to http://localhost:8080

Environment Variables

Variable	What it is	Default value
`DB_USER`	Database user	None. Required
`DB_PASSWORD`	Database password	None. Required
`DB_DB`	Database name	None. Required
`DB_HOST`	Database host	`localhost`
`PRIVATE_KEY`	Generated private key	None. Required
`PUBLIC_KEY`	Generated public key	None. Required
`PORT`	Port to run app on	`8080`
`STATIC_DIR`	Relative dir where static files are stored	`static`
`AUTO_APPROVE`	Automatically approves public posts	false
`TWITTER_KEY`	Twitter consumer key	`notreal`
`TWITTER_SECRET`	Twitter consumer secret	`notreal`
`TWITTER_TOKEN`	Twitter access token of the posting Twitter account	`notreal`
`TWITTER_TOKEN_SECRET`	Twitter access token secret of the posting Twitter account	`notreal`

Notes

Changing CSS. Run make after all changes to update the stylesheets.

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.

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.