akf-forum/README.md
2022-08-31 15:31:23 +03:00

2.2 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:

To do Is done? Priority
Profile Message 🔴 LOW
from form to AJAX 🟢 HIGH
auto-scroll 🟡 LOW
Page support, support message limit correct 🟢 MEDIUM
Multi-theme support, black theme 🟡 LOW
Search 🔴 MEDIUM
Footer 🟢 LOW
  • Profile photos will store in database
  • replacer function global
  • author name of thread
  • page for threads - users
  • extra ratelimits
  • better edits
  • IP BAN fix
  • message counts for API
  • ZATEN SİLİNDİ BU KİŞİ & MESAJ
  • delete thread for threads area
  • delete admin request, moreover, add it to user patch delete 😳
  • user -> ips []

API

To do Is done?
RATELIMITS 🟢
Get a lots of message & thread & user 🔴
Create message & thread & user 🟢
Get message & thread & user 🟢
Delete message & thread & user 🟢
Undelete message & thread & user 🟢
Edit message & thread & user 🟢

Major Version History

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