https://github.com/tonychouteau/botmanagerapi
Rest API to manage bot with web & discord acces
https://github.com/tonychouteau/botmanagerapi
bash-script discordjs expressjs javascript nodejs reactjs rest-api
Last synced: 2 months ago
JSON representation
Rest API to manage bot with web & discord acces
- Host: GitHub
- URL: https://github.com/tonychouteau/botmanagerapi
- Owner: TonyChouteau
- Created: 2020-05-07T09:37:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-05T19:47:34.000Z (almost 5 years ago)
- Last Synced: 2025-01-31T16:36:05.339Z (4 months ago)
- Topics: bash-script, discordjs, expressjs, javascript, nodejs, reactjs, rest-api
- Language: JavaScript
- Homepage: http://vps.tonychouteau.fr/bots
- Size: 1.02 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **REST API project**
## **Description**
This project presents a way to manage bots and how we can discuss with them. It's an API which is using REST. It allows you to create, update and manage bots, including their brain(s) *-- Rivescript files which describes their behavior --* and their mouth(s) *-- which allows them to talk on different platforms*.
## **Installation**
This project uses node, make sure you have installed it, then do :
Install all modules :
```bash
npm install
```
Start the Server :
```
npm start
```
## **Use the API**
[Documentation API](./resources/wiki/DOC.MD)
## **Discord mouth**
[Documentation API](./resources/wiki/DISCORD.MD)
## **Web mouth**
N/A
## **Testing Script**
The script [test.sh](test.sh) allows you to test some requests written in [request.txt](request.txt).
### Synopsis
./test.sh \ [line]
\ :
* -h, -help : *Displays the help*
* -s, -short : *Displays the short version of the test*
* -d, -details : *Displays the detailed version of the test*
* -l, -line : *Executes the line [line] of the file request.txt*
[line] :
* *Can only be used with the -line option*
## **Potential Errors**
If you are using windows, [test.sh](test.sh) may encounter this error :
```
Unknown command "\r$"
```
To solve this error, you can use one of the following commands :
```bash
sed -i 's/\r$//' test.sh request.txt
```
OR
```bash
dos2unix test.sh; dos2unix request.txt
```
## **Authors**
* Tony CHOUTEAU
* Sébastien HERT