akf-forum/README.md

57 lines
1.6 KiB
Markdown
Raw Normal View History

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-03-31 00:40:19 +03:00
A Node.js based forum software.
2022-03-13 16:16:46 +03:00
## Installation
- Clone this repo. Or download it.
- Write `npm i` to install **dependencies**.
2022-03-22 21:25:09 +03:00
- Write `npm restart` for **reset database**, and `npm start` for run it.
- Note, the reset database is important!
2022-03-13 16:16:46 +03:00
## API
Akf-forum has got an API for other clients etc. You can test api with run apitest.py.
And, you can learn informations about API in `APIDOCS.md`.
2022-03-13 16:16:46 +03:00
## Credits
* [Akif9748](https://github.com/Akif9748) - Project owner, main developer
2022-03-13 16:16:46 +03:00
* [Camroku](https://github.com/Camroku) - Made stylesheets
2022-03-31 00:40:19 +03:00
## To Do (Backend, bug fixes)
2022-03-20 23:52:20 +03:00
- Better error codes, example 400 for bad request
- Database change. (To MongoDB)
2022-03-22 00:16:47 +03:00
- Better DB writing. Example, not `message.author.id`, `messsage.authorID`
2022-03-31 00:40:19 +03:00
- `/errors/error` will change, better error page.
2022-03-13 16:16:46 +03:00
## Roadmap
- [x] User
- [x] Login
- [x] Register
- [x] Logout
- [x] Admin
- [x] Message count
2022-03-13 17:12:09 +03:00
- [x] Delete User
- [ ] Singature & About me
- [ ] Edit user
2022-03-13 16:16:46 +03:00
- [ ] Messages
2022-03-22 00:16:47 +03:00
- [x] Ratelimit for sending message
2022-03-13 16:16:46 +03:00
- [x] Send message
- [x] Delete message
- [ ] Edit message
- [x] React message
- [ ] Threads
2022-03-31 00:40:19 +03:00
- [x] Open it!
- [ ] Edit it!
- [ ] Delete it!
2022-03-13 16:16:46 +03:00
- [ ] Other
- [x] API
- [x] Other client for forum via API
2022-03-31 00:40:19 +03:00
- [x] Footer of the site
- [ ] Multiple theme support
- [ ] Search
2022-03-13 16:16:46 +03:00
- [x] New Thread theme, better render for messages
2022-03-31 00:50:08 +03:00
- [ ] sending message etc. Will turn api model
2022-03-13 16:16:46 +03:00
## Image:
2022-03-26 23:29:51 +03:00
![image](https://user-images.githubusercontent.com/70021050/160255959-ef216cba-1348-4d4b-9347-fe67e21348e7.png)
2022-03-13 16:16:46 +03:00