akf-forum/README.md
2022-09-16 22:46:08 +03:00

1.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, and forum name...

API

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

And you can use offical API wrapper.

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

TO-DO list

To do Is done? Priority
Profile Message 🟡 LOW
IPs of users will add UserModel with select- MEDIUM
Better Auth MEDIUM
  • mod role, permissions
  • Fix footer, theme, category pages
  • upload other photos, model for it
  • category system bloat.
  • replace not found errors with no perm
  • prewiev for send messages in markdown format. Markdown in user about, deprecate clean content

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