dmi-tcat

(โ˜… 371)

Digital Methods Initiative - Twitter Capture and Analysis Toolset

  • .gitignore
  • .project
  • CODE_OF_CONDUCT.md
  • config.php.example
  • CONTRIBUTING.md
  • docker-compose.yml
  • docker-compose_prod.yml
  • Dockerfile
  • LICENSE
  • nomodify.txt
  • README.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/digitalmethodsinitiative/dmi-tcat

Downloads the entire project code from GitHub to your computer.

cd dmi-tcat

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl https://raw.githubusercontent.com/digitalmethodsinitiative/dmi-tcat/master/helpers/tcat-install-linux.sh | sudo bash

Type this command into your terminal and run it.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
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 compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

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

4. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd capture/common/geoPHP

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

composer install

Installs the PHP libraries listed in composer.json.

โœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.
// repository documentation