Giter Club home page Giter Club logo

streetsign's Introduction

StreetSign (Server)

Coverage Status

A digital signage system, inspired by Concerto, however written in Flask/Peewee/Python, with a simpler basis. This project was originally written for Teenstreet 2013 in Germany (http://www.teenstreet.de).

Although this has been used at large conferences, and is currently used in some corporate environments, and has quite a lot of tests - this version was written pretty quickly under tight deadlines, so doesn't have the most solid archetexture ever. I would like to re-write it at some point.

This has just recently been ported to Python3, after not having many updates in a while.

There is documentation at streetsign.readthedocs.org

Usage:

clone this into the directory you want to use for the project, and type

./setup.sh

and you're going!

To run the app with the flask autoreloading magic use

./run.py

for production deployment, you can run:

./run.py waitress

to run the server using the waitress WSGI server, or you can use any other WSGI server of your choice. It is recommended for 'big' deployments that you use nginx or a similar reverse proxy in front of the WSGI server, and also that you serve the static folder (javascript, css, pictures, etc) statically.

Requirements:

Most packages will be installed by the ./setup.sh script into a folder called .virtualenv.

You you will need Python 3.6+ and the Python headers package (python3-dev on Debian, python3-devel on CentOS), with a functioning gcc for compiling the various requirements.

For the thumbnail generation, and image-resizing, you'll need 'ImageMagick' installed (the 'convert' command).

So on CentOS:

yum install python3-devel ImageMagick

or on Debian/Ubuntu:

apt-get install python3-pip python3-dev imagemagick

More info:

The virtual env is kept in .virtualenv, and usually shouldn't need to be touched. I don't like the entering and exiting a virtualenv business, so went with the 'virtualenv stuff happens transparently when you use run.py, you shouldn't have to care about it' approach. If you want to run python for the virtualenv, use .virtualenv/bin/python

The setup.sh script is to allow you to get up an running on a new machine in seconds. (On an old machine, minutes, while it downloads and installs flask...) I like the github idea of 'all a new developper needs to do is run one command, and they have a whole system ready to go'.

When first installed, the initial login credentials are:

user: admin password: password

There are also some other basic users created. You should change the admin password, and delete those users before deployment.

pre-commit hook

There is the pre-commit script by Sebastian Dahlgren in the .setup/hooks/ folder, which will run pylint on python scripts to check they are valid before you commit them. The setup.sh script will copy this into your .git/hooks by default.

To run a git commit without using this, use:

git commit --no-verify

(or git commit -an also works...)

Other notes

See the main documentation

Magic Vars in posts:

You can use 2 magic variables in html or text posts:

%%TIME%%

and

%%DATE%%

these will be replaced by the current time, or date, respectively, and are kept up to date by the system.

Why isn't my post showing up?!

  • Does it have time restrictions which are in the way?
  • Is it published?
  • Does the output screen have the correct feeds selected?
  • Try refreshing the output screen (this shouldn't need to happen, but hey, it's currently work in progress)

streetsign's People

Contributors

danthedeckie avatar dependabot[bot] avatar jswetzen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

streetsign's Issues

Feature request: iframe in post

Firstly, thanks for this cool repo!

It would be great if you could add the option to allow iframe's to be added to posts. The HTML iframe code gets stripped out or doesn't work when I use it in a new post with rich text or plain text.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.