Skip to content
An appraisal tool for the web.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
dist
notes build server and commands Nov 29, 2017
src Merge branch 'master' of github.com:DocNow/docnow Mar 5, 2019
test
userData
.babelrc
.eslintrc rendering bars with d3 Oct 30, 2017
.gitignore add dist again Feb 12, 2018
.travis.yml
Dockerfile moved server Nov 29, 2017
LICENSE
README.md
clean-up.sh
docker-compose.yml network defaults Mar 14, 2019
package-lock.json
package.json added users command to export current users as JSON Mar 5, 2019
webpack.base.config.js
webpack.dev.config.js
webpack.prod.config.js React May 26, 2017

README.md

Build Status

The web is a big and rapidly changing place, so it can be challenging to discover what resources related to a particular event or topic are in need of archiving. Appraisal is an umbrella term for the many processes by which archivists identify records of enduring value for preservation in an archive. DocNow is an appraisal tool for the web.

DocNow allows archivists to tap into conversations in Twitter to help them discover what web resources are in need of archiving. Its goal is to help ensure ethical practices in web archiving by building conversations between archivists and the communities they are documenting.

Architecture

This repository houses the complete DocNow application which is comprised of a few components:

  • a client side application (React)
  • a server side REST API (Node)
  • a document database (ElasticSearch)
  • a messaging queue and stats database (Redis)

Production

If you are running DocNow in production you probably will want to check out docnow-ansible which allows you to provision and configure DocNow in the cloud.

Development

To set up DocNow on your workstation you will need to install Git and Docker. Once you've got them installed open a terminal window and follow these instructions:

  1. git clone https://github.com/docnow/docnow
  2. cd docnow
  3. docker-compose up
  4. make some ☕️
  5. open http://localhost:3000

If you run into an error above

  1. sh clean-up.sh

Other known issues

The redis container will occasionally error out and can be resolved with:

sysctl vm.overcommit_memory=1

as root on the host machine

The elasticsearch container will occasionally error out and can be resolved with:

sysctl -w vm.max_map_count=262144

as root on the host machine

You can’t perform that action at this time.