placesite
v0.0.2
Published
Placesite is a small app that generates placeholder images not unlike placekitten.com
Downloads
7
Readme
Placesite
A simple image placeholder site builder written in node.js
.
Demo
Here is a a list of sites running on Placesite
Get started
Start a new node project and install placesite
via npm i --save placesite
.
Create an index.js
and add the following code:
var app = require('placesite');
app({
imagesDir: PATH_TO_IMAGES,
title: TITLE_OF_SITE,
baseUrl: DOMAIN, // placedoge.net
analyticsHTML: PATH_TO_HTML_FOR_ANALYTICS // optional
});
Development
When you're getting your site started, don't worry about seting any env vars.
Defaults
NODE_ENV = development
PORT = 3000
Production
When you're ready to run your site, set NODE_ENV
to production
and PORT
to whatever port you want.
Whats next?
This is pretty open ended. Here is a list of some thoughts.
- Themes
- Custom cache times
- Alternate imgae for size
- Improved docs
- Alternative cache/storage
Contributing
Follow code style
Add tests
Make issues
License
Copyright (c) 2013-2014 Trevor Landau
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.