# 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](https://github.com/Akif9748/akf-forum-api).** ## Credits * [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer, made **old** frontend * [Tokmak](https://github.com/tokmak0) - Made **new** frontend * [Camroku](https://github.com/Camroku) - Made **old** stylesheets ## Screenshot ### Thread Page w/Black Theme ![black-theme](https://user-images.githubusercontent.com/70021050/187899782-2ff010aa-0d39-4fc2-b00c-19bcf1623c8a.png) ### Threads Page w/Default Theme ![light-theme](https://user-images.githubusercontent.com/70021050/186941146-f9a8fbf8-9b2b-4028-afc8-81cff559d9fb.png)
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