akf-forum/README.md
Akif9748 258578e790 Undelete user
Co-authored-by: Zeynep <zeynepkotan50@gmail.com>
2022-08-26 21:04:30 +03:00

2.8 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

  • Akif9748 - Project mainteiner, main developer, made old frontend
  • Tokmak - Made new frontend
  • Camroku - Made old stylesheets

Screenshot

Old frontend

akf-forum

New frontend

image

Roadmap

TO-DO:

  • If thread deleted, not show its messages in API.
  • If redirect => /register, return

Frontend

User

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

Messages

To do Is done? Priority
Ratelimit 🟢 HIGH
Send 🟢 HIGH
Delete 🟢 HIGH
Regex for scripts 🔴 HIGH
Undelete 🔴 MEDIUM
React 🟢 MEDIUM
Edit 🔴 MEDIUM

Threads

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

API

To do Is done?
RATELIMITS 🟢
Get messages 🟢
Create message & thread & user 🟢
Get message & thread & user 🟢
Delete message & thread & user 🟢
Undelete message & thread & user 🟢
Edit message & thread & user 🔴

Other

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

New Theme

  • Login
  • Register
  • Main page
  • Error
  • Users
  • Threads
  • Create Thread
  • Thread
  • User
  • Admin