rep1y

Rep1y is a small HTML, and CSS a11y sketching board.

Setup

Clone this repo to the folder where you want a rep1y instance.


$ git clone https://notabug.org/rem/rep1y /path/to/instance

Usage

If you have a stable Ruby release in your box start a local server with:


$ rake
# or using whichever port you want
$ REP1Y_PORT=9000 rake

Ctrl-c stops the server.

If you either don't have or prefer not to use Ruby just serve rep1y's files however you like.

Rep1y auto-saves the current sketch (HTML, and CSS inputs) as part of the URL. It does so in a way that anyone who gets a hold of it may see it's contents. Never share sensitive info in the sketches.

To open sketches, simply visit the URL (locally, you might need to reload the page to actually see it).

Security

Rep1y takes basic security measurements to keep sketches shareable. Yet, as it's possible the dependencies themselves have security issues, never open sketches from people other than those whom you trust. Preferably using a modern browser which fully supports iframe.

License

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Contributing

Rep1y's codebase is minimalist; enough code to do its job properly. Contributions are more than welcome for security, and performance enhancements. Keep them short, and simple ie. neither verbose, nor obfuscated.

Readme.org 2.1 KB Permalink History Raw