readme changes and small improvement to image expand script

merge-requests/208/head
fatchan 5 years ago
parent 354ea5297d
commit 05dc5c8459
  1. 33
      README.md
  2. 4
      gulp/res/js/expand.js

@ -5,25 +5,25 @@ Still in development, so beware if attempting to run a public instance.
Demo site running at https://fatpeople.lol Demo site running at https://fatpeople.lol
## Goals ## Goals
- Oldschool imageboard look - Oldschool imageboard look, with some modern touches
- Works on TOR with javascript disabled (maybe the name is a bit ironic) - Support users that have javascript disabled (TOR users, or the security conscious)
- Leverage nginx to serve static files and handle GeoIP lookups - Leverage nginx to serve static files, do GeoIP lookups and various other things
## Features ## Features
- [x] Post styling (markdown-esque)
- [x] Quote linking and replies
- [x] Multiple files per post
- [x] User created boards ala infinity - [x] User created boards ala infinity
- [x] Captcha and basic antispam - [x] Captcha and basic antispam
- [x] Read-only JSON api - [x] Read-only JSON api
- [x] Public modlogs - [x] Public modlogs
- [x] Multi-select posts for moderation actions/reports - [x] Multi-select posts for moderation actions/reports
- [x] Fully functional for users with javascript disabled - [x] Post styling & quote linking
- [x] Backlinks shown without javascript
- [x] Multiple files per post
- [x] Thread view posts added live through websocket
## Todo ## Todo
- Staff post editing/moving/thread merging - Finish moderation tools (post editing, moving/thread merging, file hash bans, range bans, ban history)
- IP range bans + IP ban history - Configuration editor on the site without touching config files
- Configuration editor - Global settings page for filters, etc
- Overboard/multiboard/meta boards - Overboard/multiboard/meta boards
- Boards list and search page - Boards list and search page
- User created board custom pages - User created board custom pages
@ -32,13 +32,13 @@ Demo site running at https://fatpeople.lol
## Setup ## Setup
Please note: Please note:
- These are not step-by-step or complete instructions. - These are not step-by-step or complete instructions.
- For debian. - For debian(-like)
##### Requirements ##### Requirements
- Linux - Linux
- Node.js (to run the app) - Node.js (to run the app)
- MongoDB (database, duh) - MongoDB (database, duh)
- Redis (sessions, queue, locks and caching) - Redis (sessions, build task queue, locks, caching, websocket data)
- Nginx (handle https, serve static content, GeoIP lookup) - Nginx (handle https, serve static content, GeoIP lookup)
- Certbot/letsencrypt (for https cert) - Certbot/letsencrypt (for https cert)
- Imagemagick (thumbnailing images) - Imagemagick (thumbnailing images)
@ -67,11 +67,8 @@ Now clone the repo, browse to the folder and set some things up.
```bash ```bash
# in repo directory # in repo directory
$ nano configs/main.json #edit config with appropriate data $ nano configs/main.json #edit config with appropriate data
$ npm i $ npm run-script setup #install dependencies, pm2, gulp and run gulp tasks
$ npm i -g gulp pm2 $ npm run-script start #start all the backend processes
$ gulp $ pm2 list #list running pm2 processes
$ npm run-script setup
$ npm run-script start #this will start the backend
$ pm2 list #list running apps
$ pm2 logs #see logs $ pm2 logs #see logs
``` ```

@ -46,10 +46,12 @@ window.addEventListener('DOMContentLoaded', (event) => {
switch(type) { switch(type) {
case 'image': case 'image':
thumbElement.style.opacity = '0.5'; thumbElement.style.opacity = '0.5';
thumbElement.style.cursor = 'wait'
expandedElement = document.createElement('img'); expandedElement = document.createElement('img');
source = expandedElement; source = expandedElement;
source.onload = function() { source.onload = function() {
thumbElement.style.opacity = '1'; thumbElement.style.opacity = '';
thumbElement.style.cursor = '';
fileLink.appendChild(expandedElement); fileLink.appendChild(expandedElement);
toggle(thumbElement, expandedElement, fileName); toggle(thumbElement, expandedElement, fileName);
} }

Loading…
Cancel
Save