akf-forum/README.md

akf-forum

A Node.js based forum software.

Installation

• Clone this repo. Or download it.
• Write npm i to install dependencies.
• Write npm restart for reset database, and npm start for run it.
• Note, the reset database is important!

API

Akf-forum has got an API for other clients etc. You can test api with run apitest.py. And, you can learn informations about API in APIDOCS.md.

Credits

• Akif9748 - Project owner, main developer
• Camroku - Made stylesheets

To Do (Backend, bug fixes)

• Better error codes, example 400 for bad request
• Database change. (To MongoDB)
• Better DB writing. Example, not message.author.id, messsage.authorID
• /errors/error will change, better error page.

Roadmap

• User
  • Login
  • Register
  • Logout
  • Admin
  • Message count
  • Delete User
  • Singature & About me
  • Edit user
• Messages
  • Ratelimit for sending message
  • Send message
  • Delete message
  • Edit message
  • React message
• Threads
  • Open it!
  • Edit it!
  • Delete it!
• Other
  • API
  • Other client for forum via API
  • Footer of the site
  • Multiple theme support
  • Search
  • New Thread theme, better render for messages
  • sending message etc. Will turn api model

Image: