🍀 Archivist

Thread archival tool and CMS.

• Prerequisites
• Quick Start
• Features
• API
• Environment Variables
• Screenshots

Prerequisites

1. NodeJS - JavaScript runtime
2. MongoDB - Database

Quick Start

Clone the repository

git clone https://github.com/brookesb91/archivist.git

Navigate to the project directory

cd archivist

Install dependencies

npm i

Start the server

npm run start

Open a browser and navigate to the app. By default, the server is available at localhost:3000

Features

Done

• Reply hover preview
• Quote hover preview
• Quote anchors
• Colourised poster IDs*
• Country flags*
• Code formatting*
• Full archival of thread images

To Do

• Math formatting*
• Flash embed*
• Reverse image search
• Thread & post **UD

*For boards that support this feature

API

All paths are relative to the configured base URL.

Method	Path	Description
GET	/	Archive catalog view
GET	/archive/:board/:thread	Thread view
POST	/save	Archive a thread from the given URL

Environment Variables

Create a .env file in the project root to override values.

Name	Description	Default
NODE_ENV	Node environment	development
PORT	Server port	3000
HOST	Server host	localhost
MONGODB_URI	MongoDb connection URI	mongodb://localhost/archivist

Screenshots