https://github.com/webdad/botd-server
Simple CRUD Webservice, will hold the Database-Files and make them visible through HTTP-GET-Endpoints
https://github.com/webdad/botd-server
Last synced: about 2 months ago
JSON representation
Simple CRUD Webservice, will hold the Database-Files and make them visible through HTTP-GET-Endpoints
- Host: GitHub
- URL: https://github.com/webdad/botd-server
- Owner: WebDaD
- License: unlicense
- Created: 2018-01-11T14:03:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-11T14:04:15.000Z (over 8 years ago)
- Last Synced: 2025-12-26T01:28:29.109Z (5 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BOTD - node.js API Server
Simple CRUD Webservice, will hold the Database-Files and make them visible through HTTP-GET-Endpoints
## Installation
Clone the Repo, run npm install and use node app.js:
1. `git clone https://github.com/WebDaD/botd-server.git`
2. `cd botd-server`
3. `npm install`
4. `node app.js`
(We recommend using a process manager like pm2)
## Database
Simple JSON Files, read in on start from a source, hold in memory for faster reading.
### All Blessings
#### Example
```json
```
TODO ADD
#### Schema
```json
```
TODO ADD
## Yearly Calendar
#### Example
```json
```
TODO ADD
#### Schema
```json
```
TODO ADD
## API
See also docs/api.raml or docs/api.html
* GET / <- return list of endpoints
TODO add info
## Developer Info
Here are some Infos for Developer
### Tests
The Tests are written using the assert-class and can be found in the tests-folder
You may use your favorite Test-Runner to do them yourself.
My Commandline is as follows:
`istanbul cover _mocha -- tests/*.js -R mochawesome`
#### Results
Coverage: docs/coverage/lcov-report/index.html
Mochawesome-Report: docs/mochawesome-report/index.html
### Libs
ClassDiagram:
Can be found in docs/classes.png
Also as editable plantUML-File.
SequenceDiagram:
Can be found in docs/sequence.png
Also as editable plantUML-File.
__JSDOC__ in Files. See also HTML Version @ docs/jsdoc/index.html
### Dependencies
* [express](https://www.npmjs.com/package/express)
## Authors
* Dominik Sigmund
## License
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to