Thread archival tool and CMS.
- NodeJS - JavaScript runtime
- MongoDB - Database
Clone the repository
git clone https://github.com/brookesb91/archivist.git
Navigate to the project directory
Install dependencies
Start the server
Open a browser and navigate to the app. By default, the server is available atlocalhost:3000
*For boards that support this feature
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 |
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 |
