mirror of
https://github.com/Akif9748/akf-forum.git
synced 2024-07-01 06:55:41 +03:00
Akif9748
4be2069587
Co-authored-by: Sapphire1525 <Sapphire1525@users.noreply.github.com> Co-authored-by: inoaa79 <inoaa79@users.noreply.github.com>
83 lines
2.3 KiB
Markdown
83 lines
2.3 KiB
Markdown
# akf-forum
|
|
<img src="https://raw.githubusercontent.com/Akif9748/akf-forum/main/public/images/logo.jpg" align="right" width="300px" />
|
|
|
|
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](https://github.com/Akif9748) - Project mainteiner, main developer
|
|
* [Camroku](https://github.com/Camroku) - Made stylesheets
|
|
|
|
## Roadmap
|
|
### 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 |
|
|
| 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? | Priority |
|
|
| ----- | -------- | -------- |
|
|
| RATELIMITS | 🟡 | MEDIUM |
|
|
| Other clients for forum via API | 🟢 | LOW |
|
|
| Get message**s** | 🟢 | MEDIUM |
|
|
| 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 |
|
|
| auto-scroll | 🟢 | LOW |
|
|
| Multi-theme support | 🔴 | LOW |
|
|
| Search | 🔴 | MEDIUM |
|
|
| Better view, page support | 🔴 | MEDIUM |
|
|
| Sending message etc. will use fetch API | 🟢 | HIGH |
|
|
|
|
## Screenshot
|
|
|