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
369 Commits 1 Branch 103 Tags 3.1 MiB
JavaScript 59.4%
EJS 31.5%
CSS 9.1%
Go to file
Akif9748 667c0222e9 5.2.0 2023-05-24 15:43:45 +03:00
models Added themes api way, and bootstrap theme,useredit 2023-05-09 13:28:45 +03:00
public page support for categories, and one css file 2023-05-24 15:40:09 +03:00
routes login with email 2023-05-24 15:43:40 +03:00
util HTTP codes, approval system for user, email 2022-09-24 01:39:06 +03:00
views login with email 2023-05-24 15:43:40 +03:00
.env.example Added themes api way, and bootstrap theme,useredit 2023-05-09 13:28:45 +03:00
.eslintrc.json page support for categories, and one css file 2023-05-24 15:40:09 +03:00
.gitignore Added discord auth support 2022-09-17 19:33:51 +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 login with email 2023-05-24 15:43:40 +03:00
config.json.example Added themes api way, and bootstrap theme,useredit 2023-05-09 13:28:45 +03:00
index.js Added themes api way, and bootstrap theme,useredit 2023-05-09 13:28:45 +03:00
lib.js Added themes api way, and bootstrap theme,useredit 2023-05-09 13:28:45 +03:00
package-lock.json 5.2.0 2023-05-24 15:43:45 +03:00
package.json 5.2.0 2023-05-24 15:43:45 +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 color (black or white) of users, and forum name, meta description, character limits, discord auth enabler, global ratelimit.

How to install theme:

  • Copy your theme to public/themes folder.

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
  • change password.
  • add approval threads page.
  • Add a feature list to README.md
  • delete admin???
  • change category name
  • _id
  • add support for transition around gravatar
  • forum setup page rewrite and directly open a router
  • login w/ email
  • BETTER SETUP PAGE

front-end

  • text alling center body
  • add a css file for CodeMirror in threads / send message ok
  • 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
  • give admin button, not is admin
  • edit user ++
  • rewrite main page, list new messages
  • 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