|
|
|
@ -1,27 +1,26 @@ |
|
|
|
# jschan |
|
|
|
# jschan |
|
|
|
Anonymous imageboard. A type of BBS or forum software. |
|
|
|
Anonymous imageboard software. Live instance at https://fatchan.org |
|
|
|
Demo site running at https://fatpeople.lol |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Goals |
|
|
|
## Goals |
|
|
|
- Oldschool imageboard look, with some modern touches |
|
|
|
- Oldschool look, newschool feel |
|
|
|
- Support users that have javascript disabled (TOR users, or the security conscious) |
|
|
|
- Work with javascript disabled |
|
|
|
- Leverage nginx to serve static files, do GeoIP lookups and various other things |
|
|
|
- Be usable on mobile |
|
|
|
|
|
|
|
- Static file serving |
|
|
|
|
|
|
|
|
|
|
|
## Features |
|
|
|
## Features |
|
|
|
- [x] User created boards ala infinity |
|
|
|
- [x] User created boards ala infinity |
|
|
|
- [x] Multiple files per post |
|
|
|
- [x] Multiple files per post |
|
|
|
- [x] Captcha and basic antispam |
|
|
|
- [x] Captcha and antispam |
|
|
|
- [x] Read-only JSON api |
|
|
|
- [x] Read-only JSON api |
|
|
|
- [x] Multi-select moderation actions |
|
|
|
- [x] Multi-select moderation actions |
|
|
|
- [x] Websocket update threads w/o polling |
|
|
|
- [x] Websocket update threads w/o polling |
|
|
|
- [x] Webring support ([lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring)) ([infinity](https://gitlab.com/Tenicu/infinityaddon-webring)) |
|
|
|
- [x] Webring support ([lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring)) ([infinity](https://gitlab.com/Tenicu/infinityaddon-webring)) |
|
|
|
|
|
|
|
|
|
|
|
## Todo |
|
|
|
## Todo |
|
|
|
- Fix issues |
|
|
|
- Support running as a hidden service |
|
|
|
- Add missing features |
|
|
|
- More features |
|
|
|
- Improve moderation tools |
|
|
|
- Mobile app |
|
|
|
- Improve frontend scripts |
|
|
|
- Full install script |
|
|
|
- Fork some mobile app and make it compatible with the API |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Setup |
|
|
|
## Setup |
|
|
|
Please note: |
|
|
|
Please note: |
|
|
|
@ -96,10 +95,12 @@ $ npm run-script start |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# some commands you may need to use in future/find helpful |
|
|
|
# some commands you may need to use in future/find helpful |
|
|
|
|
|
|
|
|
|
|
|
# pm2 is a process manager for nodejs |
|
|
|
# pm2 is a process manager for nodejs |
|
|
|
$ pm2 list #list running pm2 processes |
|
|
|
$ pm2 list #list running pm2 processes |
|
|
|
$ pm2 logs #see logs |
|
|
|
$ pm2 logs #see logs |
|
|
|
$ pm2 reload all #reload all backend processes |
|
|
|
$ pm2 reload all #reload all backend processes |
|
|
|
|
|
|
|
|
|
|
|
# gulp is used for various jobs like minifying and compiling scripts |
|
|
|
# gulp is used for various jobs like minifying and compiling scripts |
|
|
|
$ gulp --tasks #list available gulp tasks |
|
|
|
$ gulp --tasks #list available gulp tasks |
|
|
|
$ gulp migrate #check for and run db migrations |
|
|
|
$ gulp migrate #check for and run db migrations |
|
|
|
|
