akf-forum/README.md

2.1 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 (fetch), 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

Thread Page w/Black Theme

black-theme

Threads Page w/Default Theme

light-theme

Mobile view

Roadmap

TO-DO:

To do Is done? Priority
Profile Message 🔴 LOW
Search 🔴 MEDIUM
Footer 🟡 LOW
Better Auth 🔴 MEDIUM
Local pfp store 🔴 MEDIUM
IPs of users will add SecretModel 🔴 MEDIUM
  • message counts for API
  • better theme patch UserModel
  • ajax, delete update thread dom

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