akf-forum/README.md
2022-08-11 03:49:54 +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 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.

API

Akf-forum has got an API for other clients etc. You can test api with python files in test folder.

Python is only for testing 😭 And, you can learn about API in util/APIDOCS.md.

Credits

Roadmap

User

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

Messages

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

Threads

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

API

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

Other

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

Screenshot

akf-forum