akf-forum/README.md

# akf-forum
<img src="https://raw.githubusercontent.com/Akif9748/akf-forum/main/public/images/logo.jpg" align="right" width="300px" />

A Node.js based forum software.

## Installation
- Clone or download this repo.
- Run `npm i` to install **dependencies**.
- Run `npm start` for run it. 

### Extra
Run `node util/reset` to **reset the database**, and run `node util/admin` for give admin perms to first member.
Edit `config.json` for default themes of users...

## API
Akf-forum has got an API for AJAX, other clients etc. And, you can learn about API in `util/APIDOCS.md`.

## 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
### Old frontend
![akf-forum](https://user-images.githubusercontent.com/70021050/160255959-ef216cba-1348-4d4b-9347-fe67e21348e7.png)
### New frontend
![new-akf-forum](https://user-images.githubusercontent.com/70021050/186941146-f9a8fbf8-9b2b-4028-afc8-81cff559d9fb.png)


## Roadmap
### TO-DO:
- If thread deleted, not show its messages in API.
- Profile photos will store in database
- replacer function global
- author name of thread
- page for threads - users []
- API, ?fast=
- extra ratelimits
- better edits
- IP BAN CLI IN ADMIN PANEL

### Frontend
#### User
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Login via redirect query | 🟢 | HIGH |
| Register | 🟢 | HIGH |
| Logout | 🟢 | HIGH |
| Admin | 🟢 | HIGH |
| Message count | 🟢 | MEDIUM |
| Delete user | 🟢 | HIGH |
| Undelete | 🟢 | MEDIUM |
| About me | 🟢 | LOW |
| Edit user | 🟢 | HIGH |
| IP ban | 🟢 | MEDIUM |
| Profile Message | 🔴 | MEDIUM |

#### Messages
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Ratelimit | 🟢 | HIGH |
| Send | 🟢 | HIGH |
| Delete | 🟢 | HIGH |
| Regex for scripts | 🟢 | HIGH |
| Undelete | 🟢 | MEDIUM |
| React | 🟢 | MEDIUM |
| Edit | 🟢 | MEDIUM |

#### Threads
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Ratelimit | 🟢 | HIGH |
| Create | 🟢 | HIGH |
| Delete | 🟢 | HIGH |
| Undelete | 🟢 | MEDIUM |
| Edit | 🟢 | MEDIUM |

### API
| To do | Is done? 
| ----- | -------- 
| RATELIMITS | 🟢 
| Get message**s** | 🟢 
| Create message & thread & user | 🟢 
| Get message & thread & user | 🟢 
| Delete message & thread & user | 🟢 
| Undelete message & thread & user | 🟢 
| Edit message & thread & user | 🟢 

### Other
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| from form to AJAX | 🟢 | HIGH |
| auto-scroll  | 🟢 | LOW |
| Page support, support message limit correct | 🟢 | MEDIUM |
| Multi-theme support, black theme | 🟡 | LOW |
| Search | 🔴 | MEDIUM |
| Footer | 🔴 | LOW |

## Major Version History
- V3: New Theme
- V2: Backend fix, mongoose is fixed. Really big fix.
- V1: Mongoose added.
- V0: Birth with quick.db
Fixing git 2022-03-13 16:16:46 +03:00			`# akf-forum`
			`<img src="https://raw.githubusercontent.com/Akif9748/akf-forum/main/public/images/logo.jpg" align="right" width="300px" />`

API-DOCS-FIX Co-authored-by: Serkan9748 <Serkan9748@users.noreply.github.com> 2022-08-27 09:53:10 +03:00			`A Node.js based forum software.`
Fixing git 2022-03-13 16:16:46 +03:00
			`## Installation`
Some more changes 2022-05-01 17:10:44 +03:00			`- Clone or download this repo.`
			- Run `npm i` to install dependencies.
ratelimit & crypto & .ejs fix added ratelimit to post threads and messages. Added encryption to passwords. Thread.ejs is fixed 2022-08-10 00:22:12 +03:00			- Run `npm start` for run it.
Some more changes 2022-05-01 17:10:44 +03:00
ratelimit & crypto & .ejs fix added ratelimit to post threads and messages. Added encryption to passwords. Thread.ejs is fixed 2022-08-10 00:22:12 +03:00			`### Extra`
Update README.md 2022-08-10 15:25:05 +03:00			Run `node util/reset` to reset the database, and run `node util/admin` for give admin perms to first member.
profile photo fix 2022-08-27 10:31:16 +03:00			Edit `config.json` for default themes of users...
Fixing git 2022-03-13 16:16:46 +03:00
Added API. And META informations are fixed 2022-03-20 21:37:47 +03:00			`## API`
API-DOCS-FIX Co-authored-by: Serkan9748 <Serkan9748@users.noreply.github.com> 2022-08-27 09:53:10 +03:00			Akf-forum has got an API for AJAX, other clients etc. And, you can learn about API in `util/APIDOCS.md`.
Added API. And META informations are fixed 2022-03-20 21:37:47 +03:00
Fixing git 2022-03-13 16:16:46 +03:00			`## Credits`
BUMP! NEW THEME! 2022-08-26 16:27:29 +03:00			`* [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer, made old frontend`
Update README.md 2022-08-26 16:37:26 +03:00			`* [Tokmak](https://github.com/tokmak0) - Made new frontend`
BUMP! NEW THEME! 2022-08-26 16:27:29 +03:00			`* [Camroku](https://github.com/Camroku) - Made old stylesheets`

			`## Screenshot`
Update README.md 2022-08-26 18:34:39 +03:00			`### Old frontend`
BUMP! NEW THEME! 2022-08-26 16:27:29 +03:00			`![akf-forum](https://user-images.githubusercontent.com/70021050/160255959-ef216cba-1348-4d4b-9347-fe67e21348e7.png)`
Update README.md 2022-08-26 18:34:39 +03:00			`### New frontend`
API-DOCS-FIX Co-authored-by: Serkan9748 <Serkan9748@users.noreply.github.com> 2022-08-27 09:53:10 +03:00			`![new-akf-forum](https://user-images.githubusercontent.com/70021050/186941146-f9a8fbf8-9b2b-4028-afc8-81cff559d9fb.png)`
BUMP! NEW THEME! 2022-08-26 16:27:29 +03:00
Fixing git 2022-03-13 16:16:46 +03:00
			`## Roadmap`
Added undelete ways to api 2022-08-26 20:12:23 +03:00			`### TO-DO:`
			`- If thread deleted, not show its messages in API.`
[WIP] Threads page is converting to new theme 2022-08-26 22:09:02 +03:00			`- Profile photos will store in database`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`- replacer function global`
thread converted to new theme, page support 2022-08-29 00:58:34 +03:00			`- author name of thread`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`- page for threads - users []`
new theme is fixed in everypage 2022-08-29 16:16:44 +03:00			`- API, ?fast=`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`- extra ratelimits`
			`- better edits`
http fixs, added ip ban to api, and admin panel 2022-08-29 21:32:57 +03:00			`- IP BAN CLI IN ADMIN PANEL`
new theme is fixed in everypage 2022-08-29 16:16:44 +03:00
Added undelete ways to api 2022-08-26 20:12:23 +03:00			`### Frontend`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`#### User`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
V3 2022-08-11 00:38:44 +03:00			`\| Login via redirect query \| 🟢 \| HIGH \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Register \| 🟢 \| HIGH \|`
			`\| Logout \| 🟢 \| HIGH \|`
			`\| Admin \| 🟢 \| HIGH \|`
			`\| Message count \| 🟢 \| MEDIUM \|`
			`\| Delete user \| 🟢 \| HIGH \|`
Undelete user Co-authored-by: Zeynep <zeynepkotan50@gmail.com> 2022-08-26 21:04:30 +03:00			`\| Undelete \| 🟢 \| MEDIUM \|`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`\| About me \| 🟢 \| LOW \|`
Edit user added 2022-08-29 19:35:07 +03:00			`\| Edit user \| 🟢 \| HIGH \|`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`\| IP ban \| 🟢 \| MEDIUM \|`
			`\| Profile Message \| 🔴 \| MEDIUM \|`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`#### Messages`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
ratelimit & crypto & .ejs fix added ratelimit to post threads and messages. Added encryption to passwords. Thread.ejs is fixed 2022-08-10 00:22:12 +03:00			`\| Ratelimit \| 🟢 \| HIGH \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Send \| 🟢 \| HIGH \|`
			`\| Delete \| 🟢 \| HIGH \|`
thread converted to new theme, page support 2022-08-29 00:58:34 +03:00			`\| Regex for scripts \| 🟢 \| HIGH \|`
view count for threads 2022-08-28 15:00:53 +03:00			`\| Undelete \| 🟢 \| MEDIUM \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| React \| 🟢 \| MEDIUM \|`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`\| Edit \| 🟢 \| MEDIUM \|`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`#### Threads`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
targetss 2022-08-10 02:12:36 +03:00			`\| Ratelimit \| 🟢 \| HIGH \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Create \| 🟢 \| HIGH \|`
updated 2022-08-10 00:46:54 +03:00			`\| Delete \| 🟢 \| HIGH \|`
[WIP] Threads page is converting to new theme 2022-08-26 22:09:02 +03:00			`\| Undelete \| 🟢 \| MEDIUM \|`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`\| Edit \| 🟢 \| MEDIUM \|`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00
			`### API`
Added undelete ways to api 2022-08-26 20:12:23 +03:00			`\| To do \| Is done?`
			`\| ----- \| --------`
			`\| RATELIMITS \| 🟢`
			`\| Get messages \| 🟢`
			`\| Create message & thread & user \| 🟢`
			`\| Get message & thread & user \| 🟢`
			`\| Delete message & thread & user \| 🟢`
			`\| Undelete message & thread & user \| 🟢`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`\| Edit message & thread & user \| 🟢`
Make it look better Switched roadmap to be made of tables instead of lists, added Priority column, changed 'Image' text to 'Screenshot' 2022-05-01 17:04:43 +03:00
			`### Other`
			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
profile photo fix 2022-08-27 10:31:16 +03:00			`\| from form to AJAX \| 🟢 \| HIGH \|`
readme updated 2022-08-11 18:34:56 +03:00			`\| auto-scroll \| 🟢 \| LOW \|`
Page is OK! Edits, About me, ip ban 2022-08-29 19:31:59 +03:00			`\| Page support, support message limit correct \| 🟢 \| MEDIUM \|`
[WIP] Threads page is converting to new theme 2022-08-26 22:09:02 +03:00			`\| Multi-theme support, black theme \| 🟡 \| LOW \|`
			`\| Search \| 🔴 \| MEDIUM \|`
profile photo fix 2022-08-27 10:31:16 +03:00			`\| Footer \| 🔴 \| LOW \|`
Edited information for thread 2022-08-29 22:10:03 +03:00
[WIP] Threads page is converting to new theme 2022-08-26 22:09:02 +03:00			`## Major Version History`
			`- V3: New Theme`
			`- V2: Backend fix, mongoose is fixed. Really big fix.`
			`- V1: Mongoose added.`
			`- V0: Birth with quick.db`