{"id":15653917,"url":"https://github.com/eemeli/konopas","last_synced_at":"2025-10-04T01:32:06.800Z","repository":{"id":8766005,"uuid":"10450168","full_name":"eemeli/konopas","owner":"eemeli","description":"Mobile-friendly guides for conventions, with all sorts of spiffy features","archived":false,"fork":false,"pushed_at":"2021-12-20T10:09:24.000Z","size":3406,"stargazers_count":28,"open_issues_count":13,"forks_count":18,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-24T19:53:55.441Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://konopas.github.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eemeli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2013-06-03T08:21:34.000Z","updated_at":"2024-08-29T10:14:50.000Z","dependencies_parsed_at":"2022-09-18T16:10:20.166Z","dependency_job_id":null,"html_url":"https://github.com/eemeli/konopas","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eemeli%2Fkonopas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eemeli%2Fkonopas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eemeli%2Fkonopas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eemeli%2Fkonopas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eemeli","download_url":"https://codeload.github.com/eemeli/konopas/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251790412,"owners_count":21644215,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-10-03T12:48:00.816Z","updated_at":"2025-10-04T01:32:01.769Z","avatar_url":"https://github.com/eemeli.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"KonOpas\n=======\n\nA mobile-friendly guide for conventions, with all sorts of spiffy features.\n\n**[KonOpas]** is free, open-source software distributed under the terms of the\n[ISC license](./LICENSE).\n\n\n## Description\n\n[KonOpas] is a front end for the programme of a convention, conference or any\nother single- or multi-track event. It's written in JavaScript, and it works in\npractically all modern browsers, including those on mobile phones. It can use\nHTML5 caching to make itself available even without a live net connection, and\nit remembers your item selections across sessions.\n\nThe hosting requirements for KonOpas are minimal, as all the processing is done\nby the browser; all the files are served statically. Some back-end scripting may\nbe required if you require live updates of the programme during the event.\n\nBuilt and tested for a growing number of large and small conventions and\nconferences, KonOpas is about as easy to use as possible. With automatic filter\nrule generation from your data, KonOpas can be set up for your event by just\nadding your name and logo to an HTML file, along with pointers to your\nprogramme and participant data.\n\nThe open-source KonOpas client can also talk with a dedicated KonOpas server.\nThe server enables item sync across different browsers, devices and calendar\napps; item-specific voting and commenting; and allows the event organisers to\ntrack which items were the most popular. To enable server access for your event,\nplease get in touch with us at info@konopas.org.\n\nFor links to example instances of KonOpas, take a look at the links from our\n[website][KonOpas].\n\n[KonOpas]: https://konopas.github.io/\n\n\n## Getting Started\n\nAs KonOpas is a front end for your event's programme, you'll need to actually\nmanage your programme with a different tool. So far we've got built-in\nintegration with at least [Conference Planner]/[Grenadine] and [Zambia], with\nmore to come. For smaller events, a simple [PHP script] is available for\nfetching data from a publicly readable Google Drive Spreadsheet and converting\nit to the [KonOpas format][KO-fmt].\n\n[Conference Planner]: http://sourceforge.net/projects/conferenceplan/\n[Grenadine]: http://events.grenadine.co/\n[Zambia]: https://github.com/olszowka/Zambia\n[PHP script]: https://github.com/eemeli/konopas/tree/master/util/gdrive2js\n[KO-fmt]: http://konopas.org/data-fmt\n\n\nTo get started, you should download the [latest release of KonOpas][KO-latest],\nwhich includes the compiled \u0026 minified Javascript and CSS files. Alternatively,\nif you clone the [repository][KO-repo], you'll have a much easier time of\nmaking changes to the skin or hacking the Javascript source, but you'll need to\ncompile the code yourself---instructions for that are in the following section.\n\n[KO-latest]: https://github.com/eemeli/konopas/releases/latest\n[KO-repo]: https://github.com/eemeli/konopas\n\nIn the zip file, you'll find the distribution version of KonOpas in the `dist/`\nfolder; this is what you'll need to deploy on your own server.\n\nOnce you've got your programme data in the [proper format][KO-fmt], you should\njust change the `\u003cscript\u003e` tags at the bottom of `index.html` to point to your\ndata, and open the page in a web browser. If all goes well, you should see your\nprogramme nearly ready to use! If there are problems, the first place to look\nfor more information is your browser's developer console.\n\nTo start customizing KonOpas for your event, edit the HTML file by replacing\nstand-in phrases like `KonOpas Sample Guide` and `CONVENTION` as appropriate.\nThe `title` and `title-small` images are the logo that's displayed at the top of\nthe page; there are two as you may wish to use a different graphic for the wide\nand narrow-aspect layouts. Near the bottom of the file you'll find the KonOpas\ninstantiation, with optional [customizations][KO-cfg].\n\nFor more in-depth changes such as changes to the color scheme or fonts, you'll\nneed to edit the `skin/*.less` files and recompile them into CSS. For\ninternationalization and other needs, we have a few other [utilities][KO-util]\navailable.\n\nThe HTML5 [cache manifest] is by default not enabled, as it makes testing and\ndevelopment a bit of a hassle. To enable, you should update the contents of\n`konopas.appcache` to match your deployment and add a reference to it in the\n`\u003chtml\u003e` tag. Do check that your server is properly serving it with the\n`text/cache-manifest` MIME type, and that the manifest doesn't include itself\n(debugging a bad manifest can be tricky).\n\n[KO-cfg]: https://konopas.github.io/config\n[KO-util]: https://konopas.github.io/util/\n[cache manifest]: http://en.wikipedia.org/wiki/Cache_manifest_in_HTML5\n\n\n## Compilation \u0026 Dependencies\n\nFor most use cases, KonOpas should be usable directly. However, if you'd like to\nchange things such as the interface language, or if you'd like to just poke\nunder the hood in general, you'll need to recompile it.\n\nFor **styling**, KonOpas uses [LESS], which requires compilation into CSS if\nmodified. This should make it easier for you to tune the default skin to match\nyour needs. [`skin/main.less`](skin/main.less) is the place where the\ncolourscheme is set.\n\nFor **internationalization**, we use [messageformat.js], which is based on\n[ICU MessageFormat] syntax. So far [localizations](src/i18n/) include English,\nFinnish, and Swedish.\n\n[LESS]: http://lesscss.org/\n[messageformat.js]: https://github.com/SlexAxton/messageformat.js\n[ICU MessageFormat]: http://userguide.icu-project.org/formatparse/messages\n\n### make\n\nTo compile KonOpas for yourself, you should clone the git repo and install the\ndependencies using [npm]. The following commands should get you set up:\n```\ngit clone https://github.com/eemeli/konopas.git\ncd konopas\nnpm install\nmake all\n```\n\nThe `all` and `dev` make targets will build the browser-ready KonOpas in the\n`dist/` subdirectory; `make precache` gzips some of the more compressible output\nfiles for use on servers that where a config\n[like this](util/apache-enable-gzip.conf) is in use. If you've [Watchman]\ninstalled, `make watch` will start it with triggers for automatically updating\nthe JS \u0026 CSS files during development.\n\nTo change the default (English) locale of KonOpas, use the `LC` variable:\n```\nLC=en,fi make all\n```\nOnce set, the same locale will be used until reset as above or by `make clean`.\n\n[npm]: https://www.npmjs.com/\n[Watchman]: https://github.com/facebook/watchman\n\n\n## Discussion\n\nWe have a public [mailing list][KO-list] that you're welcome to join, or just\nfollow online.\n\n[KO-list]: https://groups.google.com/d/forum/konopas-dev\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feemeli%2Fkonopas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feemeli%2Fkonopas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feemeli%2Fkonopas/lists"}