Akif9748/akf-forum
Akif9748
/
akf-forum
mirror of https://github.com/Akif9748/akf-forum.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A Node.js based forum software
343 Commits 1 Branch 103 Tags 3.1 MiB
JavaScript 59.4%
EJS 31.5%
CSS 9.1%
Go to file
Akif9748 0663f968d2 caching 2022-10-09 21:33:47 +03:00
models Added state for users. 2022-10-09 21:23:31 +03:00
public message&thread search user profile 2022-10-09 20:58:55 +03:00
routes Added state for users. 2022-10-09 21:23:31 +03:00
util HTTP codes, approval system for user, email 2022-09-24 01:39:06 +03:00
views Added state for users. 2022-10-09 21:23:31 +03:00
.env.example Added unauth w/discord, and better auth 2022-09-24 00:15:17 +03:00
.gitignore Added discord auth support 2022-09-17 19:33:51 +03:00
APIDOCS.md Added unauth w/discord, and better auth 2022-09-24 00:15:17 +03:00
LICENSE Server side license 2022-08-28 15:45:19 +03:00
README.md Added state for users. 2022-10-09 21:23:31 +03:00
config.json.example Added state for users. 2022-10-09 21:23:31 +03:00
index.js caching 2022-10-09 21:33:47 +03:00
lib.js Added state for users. 2022-10-09 21:23:31 +03:00
package-lock.json 4.19.2 2022-10-09 21:23:52 +03:00
package.json 4.19.2 2022-10-09 21:23:52 +03:00

README.md

akf-forum

A Node.js based forum software.

Installation

  • Clone or download this repo.
  • Run npm i to install dependencies.
  • Enter your database credentials in .env.
  • Run npm start for run it.
  • Go /setup page for setup your forum.

Extra (If you are not use setup page)

Run node util/reset to reset the database for duplicate key errors, and run node util/admin for give admin perms to first member. 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:

"discord_auth": "your_app_id" in config.json. Add your app secret to .env as DISCORD_SECRET. Create a redirect url in discord developer portal: https://forum_url.com/auth/discord

EMAIL AUTH:

You can configure it. Just edit config.json and .env files. "email_auth": true, "default_user_state": "APPROVAL" in config.json. Add your email credentials to .env as EMAIL_USER and EMAIL_PASS. Add your email domain to .env as EMAIL_SERVICE.

API

Akf-forum has got an API for AJAX (fetch), other clients etc. And, you can learn about API in APIDOCS.md.

And you can use offical API wrapper.

Credits

  • Akif9748 - Project mainteiner, main developer, made old frontend
  • Tokmak - Made new frontend
  • Camroku - Made old stylesheets

Screenshot

Thread Page w/Black Theme

black-theme

Threads Page w/Default Theme

light-theme

Mobile view

TO-DO list

  • Profile Message or DM
  • mod role, permissions
  • upload other photos, model for it
  • categories page is need a update, thread count in category
  • Disable last seen button for web.
  • old contents / titles add to forum interface
  • add ban button to user profile.
  • change password.
  • add approval threads page.
  • who liked a message for web.
  • edit config from web admin panel.
  • user.state for ban, delete, etc.
  • Add a feature list to README.md
  • delete admin???
  • change category name

Major Version History

  • V4: Caching
  • V3: New Theme
  • V2: Backend fix, mongoose is fixed. Really big fix.
  • V1: Mongoose added.
  • V0: Birth with quick.db