akf-forum/README.md

2.9 KiB

akf-forum

A Node.js based forum software.

Installation

  • Clone or download this repo.
  • Run npm i to install dependencies.
  • Run npm start for run it.

Extra

Run node util/reset to reset the database, and run node util/admin for give admin perms to first member. Edit config.json for default themes of users...

API

Akf-forum has got an API for AJAX, other clients etc. And, you can learn about API in util/APIDOCS.md.

Credits

  • Akif9748 - Project mainteiner, main developer, made old frontend
  • Tokmak - Made new frontend
  • Camroku - Made old stylesheets

Screenshot

Old frontend

akf-forum

New frontend

new-akf-forum

Roadmap

TO-DO:

  • If thread deleted, not show its messages in API.
  • Profile photos will store in database
  • replacer function global
  • author name of thread
  • page for threads - users []
  • API, ?fast=
  • extra ratelimits
  • better edits

Frontend

User

To do Is done? Priority
Login via redirect query 🟢 HIGH
Register 🟢 HIGH
Logout 🟢 HIGH
Admin 🟢 HIGH
Message count 🟢 MEDIUM
Delete user 🟢 HIGH
Undelete 🟢 MEDIUM
About me 🟢 LOW
Edit user 🟡 HIGH
IP ban 🟢 MEDIUM
Profile Message 🔴 MEDIUM

Messages

To do Is done? Priority
Ratelimit 🟢 HIGH
Send 🟢 HIGH
Delete 🟢 HIGH
Regex for scripts 🟢 HIGH
Undelete 🟢 MEDIUM
React 🟢 MEDIUM
Edit 🟢 MEDIUM

Threads

To do Is done? Priority
Ratelimit 🟢 HIGH
Create 🟢 HIGH
Delete 🟢 HIGH
Undelete 🟢 MEDIUM
Edit 🟢 MEDIUM

API

To do Is done?
RATELIMITS 🟢
Get messages 🟢
Create message & thread & user 🟢
Get message & thread & user 🟢
Delete message & thread & user 🟢
Undelete message & thread & user 🟢
Edit message & thread & user 🟢

Other

To do Is done? Priority
from form to AJAX 🟢 HIGH
auto-scroll 🟢 LOW
Page support, support message limit correct 🟢 MEDIUM
Multi-theme support, black theme 🟡 LOW
Search 🔴 MEDIUM
Locales 🔴 LOW
Footer 🔴 LOW

Major Version History

  • V3: New Theme
  • V2: Backend fix, mongoose is fixed. Really big fix.
  • V1: Mongoose added.
  • V0: Birth with quick.db