mirror of
https://github.com/Akif9748/akf-forum.git
synced 2024-12-22 23:59:08 +03:00
A Node.js based forum software
errors | ||
middlewares | ||
models | ||
public | ||
routes | ||
tests | ||
util | ||
views | ||
.env.example | ||
.gitignore | ||
index.js | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md |
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
To do (Backend, bug fixes)
/errors/error
willchangedeprecate, it will be in res.error . And we will use "alert" for errors with fetch api.- Redirect query. Login/register button will be a script.
- message.js/12, so, admin perms,(req.user?.admin || !thread.deleted), and api in message.
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 |
React | 🟢 | MEDIUM |
Edit | 🔴 | HIGH |
Threads
To do | Is done? | Priority |
---|---|---|
Create | 🟢 | HIGH |
Delete | 🟢 | HIGH |
Edit | 🔴 | HIGH |
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 | 🔴 | MEDIUM |
React | 🟢 | MEDIUM |
Other
To do | Is done? | Priority |
---|---|---|
Footer | 🟢 | LOW |
Multi-theme support | 🔴 | LOW |
Search | 🔴 | MEDIUM |
Better view | 🟢 | MEDIUM |
Sending message etc. will use fetch API | 🔴 | MEDIUM |