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 forum software written in Node.js.

## 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 for first member.

## API
Akf-forum has got an API for other clients etc. You can test api with run apitest.py.
And, you can learn about API in `util/APIDOCS.md`.

## Credits
* [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer
* [Camroku](https://github.com/Camroku) - Made stylesheets

## To do (Backend, bug fixes) 
- `/errors/error` will change, better error page.
- Redirect query.
- message.js/12, so, admin perms,(req.user?.admin || !thread.deleted), and api in message
- the forum will only use api path...
## Roadmap
### User
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Login | 🟢 | HIGH |
| Register | 🟢 | HIGH |
| Logout | 🟢 | HIGH |
| Admin | 🟢 | HIGH |
| Message count | 🟢 | MEDIUM |
| Delete user | 🟢 | HIGH |
| About me | 🔴 | LOW |
| Edit user | 🔴 | HIGH |
| IP ban | 🔴 | MEDIUM |

### Messages
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Ratelimit | 🟢 | HIGH |
| Send | 🟢 | HIGH |
| Delete | 🟢 | HIGH |
| React | 🟢 | MEDIUM |
| Edit | 🔴 | HIGH |

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

### API
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Other clients for forum via API | 🟢 | LOW |
| Send message | 🟢 | MEDIUM |
| Create thread | 🟢 | MEDIUM |
| Get info about thread | 🟢 | MEDIUM |
| Delete message & thread | 🔴 | MEDIUM |
| Edit message & thread | 🔴 | MEDIUM |


### Other
| To do | Is done? | Priority |
| ----- | -------- | -------- |
| Footer | 🟡 | LOW |
| Multi-theme support | 🔴 | LOW |
| Search | 🔴 | MEDIUM |
| Better view | 🟢 | MEDIUM |
| Sending message etc. will use fetch API | 🔴 | HIGH |

## Screenshot
![akf-forum](https://user-images.githubusercontent.com/70021050/160255959-ef216cba-1348-4d4b-9347-fe67e21348e7.png)
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" />`

Some more changes 2022-05-01 17:10:44 +03:00			`A forum software written in Node.js.`
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`
			Run `node util/reset` to reset the database, and run `node util/admin` for give admin perms for first member.
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`
			`Akf-forum has got an API for other clients etc. You can test api with run apitest.py.`
Mongoose is fixed & optimized The dublicate key error fixed, ids as string. classes removed. using mongoose's magic 2022-08-09 19:16:34 +03:00			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`
Some more changes 2022-05-01 17:10:44 +03:00			`* [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer`
Fixing git 2022-03-13 16:16:46 +03:00			`* [Camroku](https://github.com/Camroku) - Made stylesheets`

Some more changes 2022-05-01 17:10:44 +03:00			`## To do (Backend, bug fixes)`
Update README.md 2022-03-31 00:40:19 +03:00			- `/errors/error` will change, better error page.
Update README.md 2022-04-06 16:08:11 +03:00			`- Redirect query.`
API is optimized, and better ratelimit 2022-08-10 02:08:18 +03:00			`- message.js/12, so, admin perms,(req.user?.admin \|\| !thread.deleted), and api in message`
targetss 2022-08-10 02:12:36 +03:00			`- the forum will only use api path...`
Fixing git 2022-03-13 16:16:46 +03:00			`## Roadmap`
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			`### User`
			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Login \| 🟢 \| HIGH \|`
			`\| Register \| 🟢 \| HIGH \|`
			`\| Logout \| 🟢 \| HIGH \|`
			`\| Admin \| 🟢 \| HIGH \|`
			`\| Message count \| 🟢 \| MEDIUM \|`
			`\| Delete user \| 🟢 \| HIGH \|`
			`\| About me \| 🔴 \| LOW \|`
			`\| Edit user \| 🔴 \| HIGH \|`
targetss 2022-08-10 02:12:36 +03:00			`\| IP ban \| 🔴 \| 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
			`### Messages`
			`\| 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 \|`
			`\| React \| 🟢 \| MEDIUM \|`
updated 2022-08-10 00:46:54 +03:00			`\| Edit \| 🔴 \| HIGH \|`
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
			`### Threads`
			`\| 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 \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Edit \| 🔴 \| HIGH \|`
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`
			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Other clients for forum via API \| 🟢 \| LOW \|`
			`\| Send message \| 🟢 \| MEDIUM \|`
			`\| Create thread \| 🟢 \| MEDIUM \|`
			`\| Get info about thread \| 🟢 \| MEDIUM \|`
targetss 2022-08-10 02:12:36 +03:00			`\| Delete message & thread \| 🔴 \| MEDIUM \|`
			`\| Edit message & thread \| 🔴 \| 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
			`### Other`
			`\| To do \| Is done? \| Priority \|`
			`\| ----- \| -------- \| -------- \|`
targetss 2022-08-10 02:12:36 +03:00			`\| Footer \| 🟡 \| LOW \|`
updated 2022-08-10 00:46:54 +03:00			`\| Multi-theme support \| 🔴 \| LOW \|`
Put emojis instead of text in readme 2022-05-01 17:07:01 +03:00			`\| Search \| 🔴 \| MEDIUM \|`
			`\| Better view \| 🟢 \| MEDIUM \|`
targetss 2022-08-10 02:12:36 +03:00			`\| Sending message etc. will use fetch API \| 🔴 \| HIGH \|`
Fixing git 2022-03-13 16:16:46 +03:00
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			`## Screenshot`
			`![akf-forum](https://user-images.githubusercontent.com/70021050/160255959-ef216cba-1348-4d4b-9347-fe67e21348e7.png)`