A Node.js based forum software
Go to file
Akif9748 fe550051a7 5.5.0 2023-05-26 19:40:19 +03:00
src change pass & email 2023-05-26 19:40:14 +03:00
util better folder system 2023-05-25 17:47:54 +03:00
.env.example better discord auth 2023-05-25 17:58:47 +03:00
.eslintrc.json better discord auth 2023-05-25 17:58:47 +03:00
.gitignore fix for cropper 2023-05-26 19:06:02 +03:00
APIDOCS.md Added edit config to web 2022-10-09 22:57:46 +03:00
LICENSE Server side license 2022-08-28 15:45:19 +03:00
README.md email & pass change 2023-05-26 19:39:57 +03:00
config.json.example better discord auth 2023-05-25 17:58:47 +03:00
package-lock.json 5.5.0 2023-05-26 19:40:19 +03:00
package.json 5.5.0 2023-05-26 19:40:19 +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 theme for users, forum name, meta description, character limits, discord auth enabler, global ratelimit etc.

How to install theme:

  • Copy your theme to src/themes folder. Additional note for themes: If a theme has not got any .ejs file, it will use default theme's .ejs files. default theme is in themes folder, named as common.

DISCORD AUTH:

"discord_auth": true in config.json. Add your app secret and app id to .env as DISCORD_SECRET and DISCORD_ID. 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/Bootstrap theme

image

TO-DO list

  • Profile Message or DM
  • roles & permissions
role: "moderator",
permissions: ["see_deleted_message"]
  • rewrite api ways
  • upload other photos, model for it
  • add approval threads page.
  • Add a feature list to README.md
  • Admin cant delete other admins.
  • change category name
  • add support for trans around gravatar and upload photo
  • BETTER SETUP PAGE
  • add used open source libraries to README.md
  • send public to common/public
  • edit template
  • download theme

front-end

  • add threads, messages etc. to extra
  • better user.ejs
  • add category to threads
  • working reset button
  • better pagination
  • text alling center body
  • old contents / titles add to forum interface
  • add ban button to user profile
  • who liked a message
  • give admin button, not is admin
  • thread.js unfuction only listener

css fix

  • admin page to css file threads:

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