{"id":20082540,"url":"https://github.com/paulgreg/rsstodolist-node-server","last_synced_at":"2025-05-06T01:30:32.867Z","repository":{"id":39490763,"uuid":"268231430","full_name":"paulgreg/rsstodolist-node-server","owner":"paulgreg","description":"rsstodolist is an URL oriented to-read-list based on an RSS XML feed","archived":false,"fork":false,"pushed_at":"2024-02-10T18:08:32.000Z","size":807,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T03:58:08.960Z","etag":null,"topics":["expressjs","node","rss","rsstodolist"],"latest_commit_sha":null,"homepage":"https://rsstodolist.eu/","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/paulgreg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2020-05-31T07:34:24.000Z","updated_at":"2024-04-24T06:56:21.241Z","dependencies_parsed_at":"2024-02-10T18:51:59.906Z","dependency_job_id":null,"html_url":"https://github.com/paulgreg/rsstodolist-node-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulgreg%2Frsstodolist-node-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulgreg%2Frsstodolist-node-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulgreg%2Frsstodolist-node-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulgreg%2Frsstodolist-node-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paulgreg","download_url":"https://codeload.github.com/paulgreg/rsstodolist-node-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224478466,"owners_count":17318088,"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":["expressjs","node","rss","rsstodolist"],"created_at":"2024-11-13T15:43:51.591Z","updated_at":"2025-05-06T01:30:32.855Z","avatar_url":"https://github.com/paulgreg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rsstodolist-node-server\n\nrsstodolist is an URL oriented to-read-list based on an RSS XML feed. Typical use case is to save web pages to read later on a RSS reader, or to send links to friends.\n\nThat application is hosted on fly.io at https://rsstodolist.eu/.\nFor more reliability and privacy, I _strongly_ suggest you to self-host that application.\n\nThanks to [Loïc Fürhoff](https://github.com/imagoiq), it can be hosted in a convenient way via docker.\n\n\n## Requirements\n\n- Node \u003e= 20\n- MariaDB or Postgres\n\nor\n\n- docker\n\n\n## Pre-requisites\n\nCopy `.env.sample` into `.env` (or `.env.docker_compose` if you are using docker-compose setup) and set the variables according your need.\n\nThe app will try to determine it’s root url. If it isn’t correct, you can specify it via `ROOT_URL` env variable.\n\nThe `PUBLIC` env variable should only be used for public instance (it disable /list and add some messages about self-hosting).\n\n\n## 1. Setup with docker-compose\n\n```shell\ndocker-compose -f ./docker/docker-compose.yml build\ndocker-compose -f ./docker/docker-compose.yml up\n```\n\n### Development\n\nTo allow fast code update, you can simply start database using docker-compose like \n`docker-compose -f ./docker/docker-compose.yml up db` and run `npm run dev` with nodemon in another shell.\n\n## 2. Setup with the DockerFile\n\n### Run the migration file\n\nYou need to apply `sql/rsstodolist.mysql` or `sql/rsstodolist.postgres` manually on your database server.\n\n### Build the image\n\nAs there is no currently public image, build the image for example like this:\n\n```shell\nnpm run docker-build\n# or\ndocker build -t rsstodolist -f ./Dockerfile .\n```\n\n### Run the container\n\nRun the container for example by linking a file containing environment variables.\n\n```shell\ndocker run --env-file ./.env rsstodolist\n```\n\nor define needed environment variables within the command:\n\n```shell\ndocker run -p 8080:6070 \\\n-e DATABASE_HOST=127.0.0.1 \\\n-e DATABASE_PORT=3306 \\\nrsstodolist\n```\n\n## 3. Setup via node \u0026 MariaDB\n\n### Run the migration file\n\nRun the migration file to create the rsstodolist database.\n\n### Install packages and start the application\n\n``` shell\nnpm install\nnpm start\n```\n\n## Commands\n\nYou can use `npm run dump` to extract all databases rows into a CSV file format.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulgreg%2Frsstodolist-node-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulgreg%2Frsstodolist-node-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulgreg%2Frsstodolist-node-server/lists"}