Update README.md

This commit is contained in:
Akif Yüce 2022-08-10 15:25:05 +03:00 committed by GitHub
parent 691c916b6d
commit 9f10a32b7c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -9,10 +9,10 @@ A forum software written in Node.js.
- Run `npm start` for run it. - Run `npm start` for run it.
### Extra ### Extra
Run `node util/reset` to **reset the database**, and run `node util/admin` for give admin perms for first member. Run `node util/reset` to **reset the database**, and run `node util/admin` for give admin perms to first member.
## API ## API
Akf-forum has got an API for other clients etc. You can test api with run apitest.py. Akf-forum has got an API for other clients etc. You can test api with python files in `test` folder. python is only for testing 😭
And, you can learn about API in `util/APIDOCS.md`. And, you can learn about API in `util/APIDOCS.md`.
## Credits ## Credits
@ -20,10 +20,10 @@ And, you can learn about API in `util/APIDOCS.md`.
* [Camroku](https://github.com/Camroku) - Made stylesheets * [Camroku](https://github.com/Camroku) - Made stylesheets
## To do (Backend, bug fixes) ## To do (Backend, bug fixes)
- `/errors/error` will change, better error page. - `/errors/error` will ~~change~~ deprecate, it will be in res.error . And we will use "alert" for errors with fetch api.
- Redirect query. - Redirect query. Login/register button will be a script.
- Will fix API - message.js/12, so, admin perms,(req.user?.admin || !thread.deleted), and api in message.
- message.js/12, so, admin perms,(req.user?.admin || !thread.deleted), and api in message
## Roadmap ## Roadmap
### User ### User
| To do | Is done? | Priority | | To do | Is done? | Priority |
@ -63,6 +63,7 @@ And, you can learn about API in `util/APIDOCS.md`.
| Create thread | 🟢 | MEDIUM | | Create thread | 🟢 | MEDIUM |
| Get info about thread | 🟢 | MEDIUM | | Get info about thread | 🟢 | MEDIUM |
| Delete message | 🔴 | MEDIUM | | Delete message | 🔴 | MEDIUM |
| React | 🟢 | MEDIUM |
### Other ### Other
| To do | Is done? | Priority | | To do | Is done? | Priority |