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-09-17 19:33:51 +03:00
- Enter your database credentials in `.env` .
2022-08-10 00:22:12 +03:00
- Run `npm start` for run it.
2022-09-23 23:10:13 +03:00
- Go /setup page for setup your forum.
2022-05-01 17:10:44 +03:00
2022-09-23 23:10:13 +03:00
### Extra (If you are not use `setup` page)
2022-09-17 15:19:41 +03:00
Run `node util/reset` to **reset the database** for duplicate key errors, and run `node util/admin` for give admin perms to first member.
2022-09-17 19:33:51 +03:00
Edit `config.json` for default themes (`black` or `default` ) of users, and forum name, meta description, character limits, discord auth enabler, global ratelimit.
### DISCORD AUTH:
2022-09-23 23:10:13 +03:00
`"discord_auth": "your_app_id"` in config.json.
2022-09-24 00:15:17 +03:00
Add your app secret to `.env` as `DISCORD_SECRET` .
2022-09-17 19:33:51 +03:00
Create a redirect url in discord developer portal:
2022-09-24 01:39:06 +03:00
`https://forum_url.com/auth/discord`
### EMAIL AUTH:
You can configure it. Just edit `config.json` and `.env` files.
2022-10-09 21:23:31 +03:00
`"email_auth": true, "default_user_state": "APPROVAL"` in config.json.
2022-09-24 01:39:06 +03:00
Add your email credentials to `.env` as `EMAIL_USER` and `EMAIL_PASS` .
Add your email domain to `.env` as `EMAIL_SERVICE` .
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-09-23 23:10:13 +03:00
- Profile Message or DM
- mod role, permissions
- upload other photos, model for it
- change password.
- add approval threads page.
2022-09-24 01:39:06 +03:00
- Add a feature list to README.md
2022-09-27 21:34:13 +03:00
- delete admin???
2022-10-06 22:11:18 +03:00
- change category name
2022-10-10 00:04:25 +03:00
- theme support++, directly edit html! patch user support!
- enchanted theme: not take all of the public! "/css
2022-10-09 22:57:46 +03:00
### front-end
- better usermenu for user profile
- old contents / titles add to forum interface
- categories page is need a update, thread count in category (?)
- add ban button to user profile.?
- who liked a message for web.
2022-10-10 00:04:25 +03:00
- give admin button
2022-10-09 22:57:46 +03:00
2022-08-26 22:09:02 +03:00
## Major Version History
2022-10-10 00:04:25 +03:00
- V5: Enchanted theme support
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
