2022-03-13 16:16:46 +03:00
|
|
|
# akf-forum
|
|
|
|
|
<img src="https://raw.githubusercontent.com/Akif9748/akf-forum/main/public/images/logo.jpg" align="right" width="300px" />
|
|
|
|
|
|
2022-05-01 17:10:44 +03:00
|
|
|
A forum software written in Node.js.
|
2022-03-13 16:16:46 +03:00
|
|
|
|
|
|
|
|
## Installation
|
2022-05-01 17:10:44 +03:00
|
|
|
- Clone or download this repo.
|
|
|
|
|
- Run `npm i` to install **dependencies**.
|
2022-08-10 00:22:12 +03:00
|
|
|
- Run `npm start` for run it.
|
2022-05-01 17:10:44 +03:00
|
|
|
|
2022-08-10 00:22:12 +03:00
|
|
|
### Extra
|
2022-08-10 15:25:05 +03:00
|
|
|
Run `node util/reset` to **reset the database**, and run `node util/admin` for give admin perms to first member.
|
2022-03-13 16:16:46 +03:00
|
|
|
|
2022-03-20 21:37:47 +03:00
|
|
|
## API
|
2022-08-10 15:25:05 +03:00
|
|
|
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 😭
|
2022-08-09 19:16:34 +03:00
|
|
|
And, you can learn about API in `util/APIDOCS.md`.
|
2022-03-20 21:37:47 +03:00
|
|
|
|
2022-03-13 16:16:46 +03:00
|
|
|
## Credits
|
2022-05-01 17:10:44 +03:00
|
|
|
* [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer
|
2022-03-13 16:16:46 +03:00
|
|
|
* [Camroku](https://github.com/Camroku) - Made stylesheets
|
|
|
|
|
|
2022-05-01 17:10:44 +03:00
|
|
|
## To do (Backend, bug fixes)
|
2022-08-11 00:49:44 +03:00
|
|
|
- We will use "alert" for errors with fetch api. this added for messages and reactions...
|
2022-08-11 00:38:44 +03:00
|
|
|
- the forum will only use api path... this added for messages and reactions...
|
2022-08-10 15:25:05 +03:00
|
|
|
|
2022-03-13 16:16:46 +03:00
|
|
|
## Roadmap
|
2022-05-01 17:04:43 +03:00
|
|
|
### User
|
|
|
|
|
| To do | Is done? | Priority |
|
|
|
|
|
| ----- | -------- | -------- |
|
2022-08-11 00:38:44 +03:00
|
|
|
| Login via redirect query | 🟢 | HIGH |
|
2022-05-01 17:07:01 +03:00
|
|
|
| Register | 🟢 | HIGH |
|
|
|
|
|
| Logout | 🟢 | HIGH |
|
|
|
|
|
| Admin | 🟢 | HIGH |
|
|
|
|
|
| Message count | 🟢 | MEDIUM |
|
|
|
|
|
| Delete user | 🟢 | HIGH |
|
|
|
|
|
| About me | 🔴 | LOW |
|
|
|
|
|
| Edit user | 🔴 | HIGH |
|
2022-08-10 02:12:36 +03:00
|
|
|
| IP ban | 🔴 | MEDIUM |
|
2022-05-01 17:04:43 +03:00
|
|
|
|
|
|
|
|
### Messages
|
|
|
|
|
| To do | Is done? | Priority |
|
|
|
|
|
| ----- | -------- | -------- |
|
2022-08-10 00:22:12 +03:00
|
|
|
| Ratelimit | 🟢 | HIGH |
|
2022-05-01 17:07:01 +03:00
|
|
|
| Send | 🟢 | HIGH |
|
|
|
|
|
| Delete | 🟢 | HIGH |
|
|
|
|
|
| React | 🟢 | MEDIUM |
|
2022-08-11 01:11:07 +03:00
|
|
|
| Edit | 🔴 | MEDIUM |
|
2022-05-01 17:04:43 +03:00
|
|
|
|
|
|
|
|
### Threads
|
|
|
|
|
| To do | Is done? | Priority |
|
|
|
|
|
| ----- | -------- | -------- |
|
2022-08-10 02:12:36 +03:00
|
|
|
| Ratelimit | 🟢 | HIGH |
|
2022-05-01 17:07:01 +03:00
|
|
|
| Create | 🟢 | HIGH |
|
2022-08-10 00:46:54 +03:00
|
|
|
| Delete | 🟢 | HIGH |
|
2022-08-11 01:11:07 +03:00
|
|
|
| Edit | 🔴 | MEDIUM |
|
2022-05-01 17:04:43 +03:00
|
|
|
|
|
|
|
|
### API
|
|
|
|
|
| To do | Is done? | Priority |
|
|
|
|
|
| ----- | -------- | -------- |
|
2022-05-01 17:07:01 +03:00
|
|
|
| Other clients for forum via API | 🟢 | LOW |
|
|
|
|
|
| Send message | 🟢 | MEDIUM |
|
|
|
|
|
| Create thread | 🟢 | MEDIUM |
|
|
|
|
|
| Get info about thread | 🟢 | MEDIUM |
|
2022-08-11 01:11:07 +03:00
|
|
|
| Delete message & thread | 🔴 | HIGH |
|
|
|
|
|
| Edit message & thread | 🔴 | HIGH |
|
2022-05-01 17:04:43 +03:00
|
|
|
|
|
|
|
|
### Other
|
|
|
|
|
| To do | Is done? | Priority |
|
|
|
|
|
| ----- | -------- | -------- |
|
2022-08-10 02:12:36 +03:00
|
|
|
| Footer | 🟡 | LOW |
|
2022-08-10 00:46:54 +03:00
|
|
|
| Multi-theme support | 🔴 | LOW |
|
2022-05-01 17:07:01 +03:00
|
|
|
| Search | 🔴 | MEDIUM |
|
|
|
|
|
| Better view | 🟢 | MEDIUM |
|
2022-08-11 01:11:07 +03:00
|
|
|
| Sending message etc. will use fetch API | 🟡 | HIGH |
|
2022-03-13 16:16:46 +03:00
|
|
|
|
2022-05-01 17:04:43 +03:00
|
|
|
## Screenshot
|
|
|
|
|
|
