mirror of
https://github.com/Akif9748/akf-forum.git
synced 2024-12-22 07:39:08 +03:00
A Node.js based forum software
models | ||
public | ||
routes | ||
util | ||
views | ||
.env.example | ||
.gitignore | ||
APIDOCS.md | ||
config.json | ||
config.json.example | ||
index.js | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
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.
Extra
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: true
in config.json.
Enter application id to .env
.
Create a redirect url in discord developer portal:
https://forum_url.com/discord_auth/hash
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
Threads Page w/Default Theme
Mobile view
TO-DO list
To do | Is done? |
---|---|
Profile Message | ⚪ |
Better Auth for API way | ⚪ |
mod role, permissions | ⚪ |
upload other photos, model for it | ⚪ |
categories page is need a update, thread count in category | ⚪ |
preview for send messages in markdown format | ⚪ |
DC auth will store code for taking tokens, and create secret model setting | ⚪ |
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