{"id":45035695,"url":"https://github.com/emanchado/narrows","last_synced_at":"2026-02-19T06:32:52.508Z","repository":{"id":21341910,"uuid":"68189275","full_name":"emanchado/narrows","owner":"emanchado","description":"Online storytelling system","archived":false,"fork":false,"pushed_at":"2026-01-22T02:13:18.000Z","size":2360,"stargazers_count":119,"open_issues_count":25,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-01-22T15:56:37.300Z","etag":null,"topics":["creative-writing","interactive-fiction","rpg","storytelling","storytelling-platform","writing"],"latest_commit_sha":null,"homepage":"http://hardcorenarrativist.org/narrows/","language":"Elm","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emanchado.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-09-14T08:42:45.000Z","updated_at":"2026-01-12T04:58:05.000Z","dependencies_parsed_at":"2024-04-30T01:32:00.706Z","dependency_job_id":"9a391e41-c793-4fe3-866d-ee254fd09082","html_url":"https://github.com/emanchado/narrows","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/emanchado/narrows","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanchado%2Fnarrows","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanchado%2Fnarrows/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanchado%2Fnarrows/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanchado%2Fnarrows/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emanchado","download_url":"https://codeload.github.com/emanchado/narrows/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanchado%2Fnarrows/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29604800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T05:11:50.834Z","status":"ssl_error","status_checked_at":"2026-02-19T05:11:38.921Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["creative-writing","interactive-fiction","rpg","storytelling","storytelling-platform","writing"],"created_at":"2026-02-19T06:32:51.423Z","updated_at":"2026-02-19T06:32:52.496Z","avatar_url":"https://github.com/emanchado.png","language":"Elm","funding_links":[],"categories":["Elm"],"sub_categories":[],"readme":"# NARROWS\n\nNARROWS is an online storytelling system. The name stands for\nNARRation On Web System. The easiest way to explain it is to\nimagine an online\n[Choose Your Own Adventure](https://en.wikipedia.org/wiki/Choose_Your_Own_Adventure)\nbook with the following differences:\n\n1. Instead of having a single reader, there are as many readers as\n   protagonists in the story (it could be one, but also four or five).\n1. Instead of having to choose between two or three preset choices\n   after each \"chapter\", readers can _write_ in a textbox whatever\n   their characters do.\n1. Instead of the narrator writing the whole story with all possible\n   branches upfront, then give it to the readers; the narrator writes\n   only one chapter at a time and waits for the readers to submit the\n   \"actions\" for their characters. Based on those actions, the\n   narrator writes the next chapter.\n\nYou can also think of it as a way of running ruleless, diceless RPGs\nonline (which is indeed the reason why I wrote it in the first\nplace).\n\n\n# Installation\n\nNARROWS is a web application with a backend. As such, it needs a\nserver connected to the internet to be used. To install you need to\nrun the following steps:\n\n1. Clone the code somewhere.\n1. Make sure you have Node.js (at least version 10) and NPM (at least\n   version 4).\n1. Run `npm install` (note that you **cannot** use yarn!)\n1. [Install Elm 0.19.1](https://guide.elm-lang.org/install/elm.html)\n1. Run `npm run build`\n1. Install MySQL, create a new user and an empty MySQL database. Make\n   sure the new user has all privileges to that database.\n1. Copy `config/default.js` to `config/local-production.js` and modify\n   any values you need.\n1. Run `NODE_ENV=production npm run dbmigrate`\n1. Run `NODE_ENV=production node build/index.js`\n\nIf all this works you will have to find a way to keep the server\nrunning, eg. [supervisor](http://supervisord.org/).\n\n## Updating the code\n\nEvery time you update the code you will have to install any new\ndependencies with:\n\n    npm install\n\nAnd run any new migrations with the following command. Note that you\nmight need to pass the `NODE_ENV` variable as in the installation\ninstructions above:\n\n    npm run dbmigrate\n\nThen you will have to recompile the frontend and backend code with:\n\n    npm run build\n\n## Running the tests\n\nTo be able to run the tests you need to create two test databases: the\nmain one, and the \"user storage\" one. For the first one you have the\nsettings in `config/test.js`. The second one is the same, except for\nthe database name, which is `narrows-userstore-test`.\n\nOnce you have the two databases created and the test user created and\nhave given access to them, you can run the tests by typing:\n\n    npm t\n\n\n# Docker\n\nThis repo includes a Dockerfile for building a deployable image. It\nalso contains a `docker-compose.yaml` suitable for quickly getting a\nlocal copy running.  The Dockerfile and compose file have been used\n(with modification) to host a production version of the app.\n\nTo get going with docker-compose:\n\n`docker-compose create \u0026\u0026 docker-compose up -d`\n\nIf you want to host it publicly and setup e-mail, add the appropriate\nDocker environment variables from below:\n\n* `PORT`: port to listen to.\n* `PUBLIC_ADDRESS`: used to generate URLs in e-mails.\n* `DB_HOST`: MySQL hostname/IP.\n* `DB_USER`: MySQL username.\n* `DB_PASSWORD`: MySQL password.\n* `DB_NAME`: database name.\n* `FROM_EMAIL`: e-mail address to send from. e.g. `\"Narrows\" \u003cno-reply@domain.com\u003e`.\n* `NODEMAILER`: a nodemailer URI configuration string, e.g. `smtps://user:pasword@smtp.host.com/?secure=true`.\n\n__Note:__ `NODEMAILER` URI strings need to URI escape special\ncharacters within username/password. For example, usernames often\ncontain `@`, and AWS SES passwords often contain `/`.\n\n# Credits\n\n## Icons/graphics\n\n* Speaker/mute icons made by\n  [Madebyoliver](http://www.flaticon.com/authors/madebyoliver), from\n  [Flaticon](http://www.flaticon.com). They are licensed under\n  Creative Commons BY 3.0.\n* Trash icon by [Freepik](http://www.flaticon.com/authors/freepik),\n  from [Flaticon](http://www.flaticon.com). Licensed under Creative\n  Commons BY 3.0.\n* Add/plus icon, message icon, user icon, info icon and edit icon by\n  [Lucy G](http://www.flaticon.com/authors/lucy-g), from\n  [Flaticon](http://www.flaticon.com). Licensed under Creative Commons\n  BY 3.0.\n* RSS icon by [Dave Gandy](http://www.flaticon.com/authors/dave-gandy)\n  from [Flaticon](http://www.flaticon.com). Licensed under Creative\n  Commons BY 3.0.\n* Vintage divider by\n  [Web Design Hot](http://www.webdesignhot.com/free-vector-%20graphics/vector-set-of-vintage-design-divider-elements/). Licensed\n  under Creative Commons BY 3.0.\n\n## Contributors\n\n* Tess Gadwa ([`tessgadwa`](https://github.com/tessgadwa)): UX help and recommendations.\n* James Sapara ([`interlock`](https://github.com/interlock)): Docker setup.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femanchado%2Fnarrows","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femanchado%2Fnarrows","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femanchado%2Fnarrows/lists"}