{"id":31879914,"url":"https://github.com/jcurbelo/beampressk","last_synced_at":"2026-05-03T01:40:34.560Z","repository":{"id":27842409,"uuid":"31332552","full_name":"jcurbelo/beampressk","owner":"jcurbelo","description":"A Flask webserver implementation to host and control presentations built with beampress.js","archived":false,"fork":false,"pushed_at":"2021-08-02T10:21:07.000Z","size":15713,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-05-03T01:39:14.530Z","etag":null,"topics":["flask","flask-socketio","python","socket-io"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcurbelo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-25T19:47:48.000Z","updated_at":"2026-03-10T18:25:19.000Z","dependencies_parsed_at":"2022-09-05T05:10:43.515Z","dependency_job_id":null,"html_url":"https://github.com/jcurbelo/beampressk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jcurbelo/beampressk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcurbelo%2Fbeampressk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcurbelo%2Fbeampressk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcurbelo%2Fbeampressk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcurbelo%2Fbeampressk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcurbelo","download_url":"https://codeload.github.com/jcurbelo/beampressk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcurbelo%2Fbeampressk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32555839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T00:31:16.350Z","status":"ssl_error","status_checked_at":"2026-05-03T00:31:15.546Z","response_time":132,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","flask-socketio","python","socket-io"],"created_at":"2025-10-13T00:38:04.246Z","updated_at":"2026-05-03T01:40:34.542Z","avatar_url":"https://github.com/jcurbelo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# beampressk\n\nA [Flask](http://flask.pocoo.org/) webserver implementation to host and control *presentations* built with [beampress.js](https://github.com/jcurbelo/beampress). It leverages the usage of [Flask-SocketIO](https://github.com/miguelgrinberg/Flask-SocketIO) and [socket.io-client](https://github.com/socketio/socket.io-client) to add _real-time_ control over the slides.\n\u003e If you want to use only the \"static\" version go to [beampress.js](https://github.com/jcurbelo/beampress)\n\n## How to use it\n\n1. Clone this repo using your preferred method:\n\n    ```bash\n    # SSH\n    $ git clone git@github.com:jcurbelo/beampressk.git\n\n    # HTTPS\n    $ git clone https://github.com/jcurbelo/beampressk.git\n\n    # GitHub CLI\n    $ gh repo clone jcurbelo/beampressk\n    ```\n\n2. Install dependencies with [pipenv](https://pipenv.readthedocs.io/en/latest/):\n\n    ```bash\n    # cd to application's root and then\n    $ pipenv install\n    ```\n\n3. Define environment variables with [`.env`](https://pipenv-fork.readthedocs.io/en/latest/advanced.html#automatic-loading-of-env) file:\n\n    ```bash\n    # python-dotenv searches for a .env file located at root\n    SECRET_KEY=YOUR_SECRET_KEY\n    BASIC_AUTH_USERNAME=YOUR_ADMIN_USER\n    BASIC_AUTH_PASSWORD=YOUR_ADMIN_PASSWORD\n    ```\n\n4. Run Flask server using [Flask CLI](https://flask.palletsprojects.com/en/1.1.x/cli/):\n\n    ```bash\n    $ pipenv run flask run\n\n    # or activate virtual env\n    $ pipenv shell\n\n    # and then run it with your local installation\n    (beampressk) $ flask run\n\n    # example output\n    Loading .env environment variables…\n    * Serving Flask app \"beampressk\" (lazy loading)\n    * Environment: development\n    * Debug mode: on\n    * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)\n    * Restarting with stat\n    * Debugger is active!\n    * Debugger PIN: 311-574-148\n    ```\n\n5. Navigate to the \"admin\" view: `/` and authenticate using the admin credentials defined on step 3 `ADMIN_USER` and `ADMIN_PASSWORD`.\n    \u003e All \"admin\" (protected) views use [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) with [Flask-BasicAuth](https://flask-basicauth.readthedocs.io/en/latest/). The purpose of beampressk is to be accessed via a \"local\" network, we don't recommend this approach for a production-like environment.\n6. Navigate to any \"presentation\" view (e.g `/presentation/example-warsaw`) and play with the admin controls.\n\n## How to add your presentations\n\n* Put your `index.html` file in `beampressk/templates/your-presentation`, where `your-presentation` is any name of your preference.\n* Navigate to `/presentation/your-presentation` URL.\n* All presentations must follow [beampress.js](https://github.com/jcurbelo/beampress) requirements in order to work.\n* You can use [Jinja syntax](https://jinja.palletsprojects.com/en/2.11.x/) along with [Template Inheritance](https://flask.palletsprojects.com/en/1.1.x/patterns/templateinheritance/) to better organize your presentations. Have a look at the *example_warsaw* demo presentation, it uses a base template called `warsaw_base.html`. Feel free to create your own base template.\n\n    ```jinja\n    {% extends \"warsaw_base.html\" %}\n    {% block content %}\n        \u003csection class=\"frame\"\u003eHello World!\u003c/section\u003e\n    {% endblock %}\n    ```\n\n## How it looks\n\n![Warsaw example](img/warsaw-example.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcurbelo%2Fbeampressk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcurbelo%2Fbeampressk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcurbelo%2Fbeampressk/lists"}