Akif9748/akf-forum
Akif9748/akf-forum
1
1
Fork 0
mirror of https://github.com/Akif9748/akf-forum.git synced 2024-11-25 04:50:41 +03:00
Code Issues Projects Releases Packages Wiki Activity
A Node.js based forum software
360 commits 1 branch 103 tags 2.1 MiB
JavaScript 59.4%
EJS 31.5%
CSS 9.1%
Find a file
Akif9748 3ac99be051 Theme change available
2023-05-08 18:17:46 +03:00
models added gravatar support 2023-05-08 17:41:16 +03:00
public rollback to v4.x, and mini fixes 2023-05-08 17:16:12 +03:00
routes Theme change available 2023-05-08 18:17:46 +03:00
util HTTP codes, approval system for user, email 2022-09-24 01:39:06 +03:00
views Theme change available 2023-05-08 18:17:46 +03:00
.env.example Added unauth w/discord, and better auth 2022-09-24 00:15:17 +03:00
.eslintrc.json rollback to v4.x, and mini fixes 2023-05-08 17:16:12 +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
config.json.example added gravatar support 2023-05-08 17:41:16 +03:00
index.js Theme change available 2023-05-08 18:17:46 +03:00
lib.js added gravatar support 2023-05-08 17:41:16 +03:00
LICENSE Server side license 2022-08-28 15:45:19 +03:00
package-lock.json 4.22.0 2023-05-08 17:41:23 +03:00
package.json 4.22.0 2023-05-08 17:41:23 +03:00
README.md Theme change available 2023-05-08 18:17:46 +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.

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++

theme to do:

  • add bootstrap for navbar
  • routes/api/routes/users.js check, themes/default/extra/footer.ejs check, themes/default/extra/meta.ejs check
  • add theme support again, but only works with css folder. Put every css file into one file. (themes/default/css/main.css)

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.
  • give admin button, not is admin

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