2022-03-13 16:16:46 +03:00
|
|
|
# akf-forum
|
2022-08-27 09:53:10 +03:00
|
|
|
A Node.js based forum software.
|
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-09-09 15:34:12 +03:00
|
|
|
Edit `config.json` for default themes of users, and forum name...
|
2022-03-13 16:16:46 +03:00
|
|
|
|
2022-03-20 21:37:47 +03:00
|
|
|
## API
|
2022-09-09 15:10:44 +03:00
|
|
|
Akf-forum has got an API for AJAX (fetch), other clients etc. And, you can learn about API in `APIDOCS.md`.
|
2022-03-20 21:37:47 +03:00
|
|
|
|
2022-09-09 21:40:02 +03:00
|
|
|
**And you can use [offical API wrapper](https://github.com/Akif9748/akf-forum-api).**
|
|
|
|
|
|
2022-03-13 16:16:46 +03:00
|
|
|
## Credits
|
2022-08-26 16:27:29 +03:00
|
|
|
* [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer, made **old** frontend
|
2022-08-26 16:37:26 +03:00
|
|
|
* [Tokmak](https://github.com/tokmak0) - Made **new** frontend
|
2022-08-26 16:27:29 +03:00
|
|
|
* [Camroku](https://github.com/Camroku) - Made **old** stylesheets
|
|
|
|
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
|
2022-09-01 14:15:48 +03:00
|
|
|
### Thread Page w/Black Theme
|
|
|
|
|
|
|
|
|
|
### Threads Page w/Default Theme
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
|
<summary><b>Mobile view</b></summary>
|
|
|
|
|
<img src="https://user-images.githubusercontent.com/70021050/187901065-fd75ef85-56e3-42ce-8b34-cb8d799a6517.png"></img>
|
|
|
|
|
</details>
|
2022-03-13 16:16:46 +03:00
|
|
|
|
2022-09-01 16:23:46 +03:00
|
|
|
## TO-DO list
|
2022-08-31 14:44:28 +03:00
|
|
|
| To do | Is done? | Priority |
|
|
|
|
|
| ----- | -------- | -------- |
|
2022-09-09 18:27:41 +03:00
|
|
|
| Profile Message | 🟡 | LOW |
|
2022-09-16 23:11:53 +03:00
|
|
|
| IPs of users will add UserModel with select- | 🟢 | MEDIUM |
|
2022-09-09 18:27:41 +03:00
|
|
|
| Better Auth | ⚪ | MEDIUM |
|
2022-09-16 23:11:53 +03:00
|
|
|
|
2022-09-16 21:57:27 +03:00
|
|
|
- mod role, permissions
|
2022-09-09 20:48:12 +03:00
|
|
|
- Fix footer, theme, category pages
|
2022-09-09 17:13:37 +03:00
|
|
|
- upload other photos, model for it
|
2022-09-16 21:57:27 +03:00
|
|
|
- category system bloat.
|
2022-09-16 23:11:53 +03:00
|
|
|
- preview for send messages in markdown format.
|
|
|
|
|
- Limits for thread title, message content, username, user about
|
2022-09-16 23:22:29 +03:00
|
|
|
- desp => description
|
2022-09-16 23:11:53 +03:00
|
|
|
|
2022-08-26 22:09:02 +03:00
|
|
|
## Major Version History
|
2022-08-31 14:44:28 +03:00
|
|
|
- V4: Caching
|
2022-08-26 22:09:02 +03:00
|
|
|
- V3: New Theme
|
|
|
|
|
- V2: Backend fix, mongoose is fixed. Really big fix.
|
|
|
|
|
- V1: Mongoose added.
|
2022-08-30 03:08:09 +03:00
|
|
|
- V0: Birth with quick.db
|
