htmlhouse

package module

v0.0.0-...-31a919f Latest Latest Go to latest Published: Jun 4, 2021 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/writeas/htmlhouse

README ¶

⌂ HTMLhouse / 🐴 CSShorse

⌂ Publish HTML quickly / 🐴 Develop a WriteFreely theme

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 an Android app.

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 cmd/htmlhouse/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`
`ALLOW_PUBLISH`	Allow users to publish posts	true
`AUTO_APPROVE`	Automatically approves public posts	false
`PREVIEWS_HOST`	Fully-qualified URL (without trailing slash) of screenshot server	None.
`ADMIN_PASS`	Password to perform admin functions via API	`uhoh`
`BROWSE_ITEMS`	Number of items to show on Browse page	10
`BLACKLIST_TERMS`	Comma-separated list of terms to prevent a post from being made public	None.
`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`
`WF_MODE`	Run CSShorse, not HTMLhouse — for customizing WriteFreely blogs	`false`

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.

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Serve ¶

func Serve()

Types ¶

type EditorPage ¶

type EditorPage struct {
	ID      string
	Content string
	Public  bool

	AllowPublish bool

	SiteURL string
}

type HouseStats ¶

type HouseStats struct {
	ID    string
	Stats []Stat
}

type PublicHouse ¶

type PublicHouse struct {
	ID    string `json:"id"`
	Title string `json:"title"`
	URL   string `json:"url"`

	ThumbURL string    `json:"thumb_url"`
	Created  time.Time `json:"created"`
	Updated  time.Time `json:"updated"`
	Views    int       `json:"views"`
	// contains filtered or unexported fields
}

type Stat ¶

type Stat struct {
	Data  string
	Label string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
htmlhouse

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL