https://github.com/aduth/small
A blogging application aimed at providing a minimal, fast, and easy-to-use interface for expressing your ideas to the world. Under the hood, it is built as an isomorphic JavaScript application powered by WordPress.com.
https://github.com/aduth/small
Last synced: about 1 year ago
JSON representation
A blogging application aimed at providing a minimal, fast, and easy-to-use interface for expressing your ideas to the world. Under the hood, it is built as an isomorphic JavaScript application powered by WordPress.com.
- Host: GitHub
- URL: https://github.com/aduth/small
- Owner: aduth
- Created: 2015-08-28T01:17:43.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-10T19:55:55.000Z (about 10 years ago)
- Last Synced: 2025-03-13T22:35:06.879Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Small is a blog application aimed at providing a minimal, fast, and easy-to-use interface for expressing your ideas to the world. Under the hood, it is built as an isomorphic JavaScript application powered by [WordPress.com](https://wordpress.com/).
## Requirements
- A [WordPress.com](https://wordpress.com) account and blog
- A server with [Node.js](https://nodejs.org/en/) installed for serving the front-end of your site
## Quick Start
If you haven't already, sign up for a free blog at [WordPress.com](https://wordpress.com/). Small uses the WordPress.com interface for drafting blog posts and managing settings for your site. While registering your blog, take note of your chosen domain, as you'll need it when configuring Small.
The easiest way to launch a Small site is using the Heroku deploy button below:
[](https://heroku.com/deploy?template=https://github.com/aduth/small)
Heroku provides a [free hosting tier](https://www.heroku.com/pricing) with the limitation that your app must sleep a minimum of 6 hours per day.
## Configuration
A Small app is configured using environment variables. Whether you choose to host your app using Heroku or with your own Node.js hosting, these variables will need to be available for both the build step and while the server process is running.
A brief description of each configuration variable is found below:
Name | Required | Description
--- | --- | ---
`SITE_ID` | Yes | Hostname of your WordPress.com blog, e.g. "andrewmduthie.wordpress.com"
`AUTHOR_EMAIL` | No | Optional email address associated with your Gravatar profile, used to retrieve connected services and Gravatar image.
`ACCOUNTS` | No | Optional comma-separated set of Gravatar connected services to use. Specify custom services using the syntax "service:url", e.g. "github:https://github.com/aduth". A service must be supported by the FontAwesome web font to be displayed correctly.
`GA_ACCOUNT_ID` | No | Optional Google Analytics account ID for tracking page views. Page views are automatically tracked using WordPress.com stats.
## License
Copyright 2015 Andrew Duthie. Released under the MIT License.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.