akf-forum/README.md
Çınar Yılmaz df671895ec
Fix type 🤦
2022-05-01 17:11:52 +03:00

2.1 KiB

akf-forum

A forum software written in Node.js.

Installation

  • Clone or download this repo.
  • Run npm i to install dependencies.
  • Run node reset to reset the database, and npm start for run it.

Note: Reseting the 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 about API in APIDOCS.md.

Credits

To do (Backend, bug fixes)

  • /errors/error will change, better error page.
  • Redirect query.
  • middleware for timeouts
  • DELETED USERS: USERLIST

Roadmap

User

To do Is done? Priority
Login 🟢 HIGH
Register 🟢 HIGH
Logout 🟢 HIGH
Admin 🟢 HIGH
Message count 🟢 MEDIUM
Delete user 🟢 HIGH
Signature 🔴 LOW
About me 🔴 LOW
Edit user 🔴 HIGH
IP ban 🔴 HIGH

Messages

To do Is done? Priority
Ratelimit 🔴 HIGH
Send 🟢 HIGH
Delete 🟢 HIGH
Edit 🔴 HIGH
React 🟢 MEDIUM

Threads

To do Is done? Priority
Create 🟢 HIGH
Edit 🔴 HIGH
Delete 🔴 HIGH

API

To do Is done? Priority
Other clients for forum via API 🟢 LOW
Delete message 🔴 MEDIUM
Send message 🟢 MEDIUM
Create thread 🟢 MEDIUM
Get info about thread 🟢 MEDIUM

Other

To do Is done? Priority
Footer 🟢 LOW
Multi-theme support 🔴 MEDIUM
Search 🔴 MEDIUM
Better view 🟢 MEDIUM
Sending message etc. will return API model 🔴 MEDIUM

Screenshot

akf-forum