conifer

(โ˜… 1,546)

Collect and revisit web pages.

  • .gitignore
  • .gitmodules
  • .travis.yml
  • appveyor.yml
  • docker-compose.yml
  • init-default.sh
  • install-browsers.sh
  • LICENSE
  • migrating-4.0.md
  • NOTICE
  • README.md
  • recreate.sh
  • search-compose.yml

# Installation Guide

1. Get the code
git clone https://github.com/Rhizome-Conifer/conifer

Downloads the entire project code from GitHub to your computer.

cd conifer

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker exec -it app python -m webrecorder.admin -c

Runs the Python script (or module).

docker exec -it app python -m webrecorder.admin \

Runs the Python script (or module).

docker-compose kill app; docker-compose up -d app

Runs the command against the services defined in the compose file.

docker-compose kill frontend; docker-compose up -d frontend

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
docker exec -it app python -m webrecorder.admin -c

Runs the Python script (or module).

docker exec -it app python -m webrecorder.admin \

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation