{"id":13565972,"url":"https://github.com/DocNow/docnow","last_synced_at":"2025-04-03T23:30:54.801Z","repository":{"id":42362931,"uuid":"81818969","full_name":"DocNow/docnow","owner":"DocNow","description":"A Twitter data collection and appraisal application.","archived":false,"fork":false,"pushed_at":"2023-03-04T02:26:47.000Z","size":16766,"stargazers_count":51,"open_issues_count":53,"forks_count":8,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-03-21T05:32:46.484Z","etag":null,"topics":[],"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/DocNow.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}},"created_at":"2017-02-13T11:41:23.000Z","updated_at":"2024-11-28T09:01:32.000Z","dependencies_parsed_at":"2023-02-09T01:02:37.768Z","dependency_job_id":"59f6d609-18fe-469c-abe1-6766f0f250e8","html_url":"https://github.com/DocNow/docnow","commit_stats":null,"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocNow%2Fdocnow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocNow%2Fdocnow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocNow%2Fdocnow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocNow%2Fdocnow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocNow","download_url":"https://codeload.github.com/DocNow/docnow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247097632,"owners_count":20883122,"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-08-01T13:01:59.195Z","updated_at":"2025-04-03T23:30:49.792Z","avatar_url":"https://github.com/DocNow.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# docnow\n\nThe web is a big and rapidly changing place, so it can be challenging to\ndiscover what resources related to a particular event or topic are in need of\narchiving. [Appraisal] is an umbrella term for the many processes by which\narchivists identify records of enduring value for preservation in an archive.\nDocNow is an appraisal tool for the social web that uses Twitter.\n\nDocNow allows archivists to tap into conversations in Twitter to help them\ndiscover what web resources for collection and preservation. It also connects\narchivists with content creators in order to make the process of archving web\ncontent more collaborative and consentful. The purpose of DocNow is to help\nensure ethical practices in web archiving by building conversations between\narchivists and the communities they are documenting.\n\nThe DocNow application has been developed with generous support from the \n[Mellon Foundation].\n\n## Architecture\n\nThis repository houses the complete DocNow application which is comprised of a\nfew components:\n\n* a client side application (React)\n* a server side REST API (Node)\n* a database (PostgreSQL)\n* a messaging queue database (Redis)\n\n## Production\n\nIf you are running DocNow in production you will want to check out\n[docnow-ansible](https://github.com/DocNow/docnow-ansible) which allows you to\nprovision and configure DocNow in the cloud.\n\n## Development\n\nThe *main* branch of this repository represents the latest tested features of the DocNow application following the [trunk based development] model. Tagged version [releases] can be used for production deployments. Development usually happens on short lived branches which are merged into *main* once they have been reviewed and approved. If you'd like to contribute to the DocNow project please fork this repository, create a branch for your feature or bug fix, and then send a pull request to have it reviewed and merged.\n\nTo set up DocNow locally on your workstation you will need to install [Git]\nand [Docker]. Once you've got them installed open a terminal window and\nfollow these instructions:\n\n1. git clone https://github.com/docnow/docnow\n1. cd docnow\n1. cp .env.dev .env\n1. docker-compose build --no-cache\n1. docker-compose up\n1. make some ☕️\n1. open http://localhost:3000\n\nIf you run into an error above and want to clean out *all* your docker containers and images you can run this: \n\n1. sh clean-up.sh\n\n## Testing\n\nThe test suite runs automatically via a GitHub Action. If you want to run the tests yourself you will need to:\n\n```\ncp .env.test-sample .env.test\n```\n\nReplace the `CHANGE_ME` values in .env.test to the respective Twitter API credentials. Then run the tests.\n\n```\nnpm run test\n```\n\nDo not commit `.env.test` to git since it contains your Twitter API keys!\n\n[Git]: https://git-scm.com/\n[Docker]: https://www.docker.com/\n[Appraisal]: https://www2.archivists.org/glossary/terms/a/appraisal\n[releases]: https://github.com/DocNow/docnow/releases\n[trunk based development]: https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development\n[Mellon Foundation]: https://mellon.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDocNow%2Fdocnow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDocNow%2Fdocnow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDocNow%2Fdocnow/lists"}