Akif9748/akf-forum
Akif9748/akf-forum
1
1
Fork 0
mirror of https://github.com/Akif9748/akf-forum.git synced 2024-11-23 04:10:40 +03:00
Code Issues Projects Releases Packages Wiki Activity

Some more changes

Browse source
This commit is contained in:
Çınar Yılmaz 2022-05-01 17:10:44 +03:00 committed by GitHub
parent b708c6f9e9
commit 3ae981c4b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,23 +1,24 @@
# akf-forum # akf-forum
<img src="https://raw.githubusercontent.com/Akif9748/akf-forum/main/public/images/logo.jpg" align="right" width="300px" /> <img src="https://raw.githubusercontent.com/Akif9748/akf-forum/main/public/images/logo.jpg" align="right" width="300px" />
A Node.js based forum software. A forum software written in Node.js.
## Installation ## Installation
- Clone this repo. Or download it. - Clone or download this repo.
- Write `npm i` to install **dependencies**. - Run `npm i` to install **dependencies**.
- Write `node reset` for **reset database**, and `npm start` for run it. - Run `node reset` to **reset the database**, and `npm start` for run it.
- Note, the reset database is important!
**Note:** the reseting the database is important!
## 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 run apitest.py.
And, you can learn informations about API in `APIDOCS.md`. And, you can learn about API in `APIDOCS.md`.
## Credits ## Credits
* [Akif9748](https://github.com/Akif9748) - Project owner, main developer * [Akif9748](https://github.com/Akif9748) - Project mainteiner, main developer
* [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, better error page.
- Redirect query. - Redirect query.
- middleware for timeouts - middleware for timeouts