Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quiode/website-chris-backend
The Backend of the Website for Christoph Anton-Cornelius Bärtsch
https://github.com/quiode/website-chris-backend
Last synced: about 1 month ago
JSON representation
The Backend of the Website for Christoph Anton-Cornelius Bärtsch
- Host: GitHub
- URL: https://github.com/quiode/website-chris-backend
- Owner: quiode
- License: gpl-3.0
- Created: 2022-02-23T17:54:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-14T20:57:34.000Z (over 1 year ago)
- Last Synced: 2024-11-06T07:28:01.597Z (3 months ago)
- Language: TypeScript
- Size: 6.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Backend for the Website of Christoph Anton-Cornelius Bärtsch
## Setup
- install ffmpeg (https://www.ffmpeg.org/download.html)
- fill the `ormconfig.env` file with your database connection
- create admin account with signup api (only possible of prod = false)
- run `typeorm schema:sync` once to sync the database with the schema (should be done automatically via TYPEORM_SYNCHRONIZE = true)
## API Documentation
### Authentication
Currently, there is only one admin user. This user can upload and delete files.
The user is authenticated by a JWT token. The token is generated by the server and sent to the client.
It will be valid for 15 minutes.
#### POST
`https://domain:3000/auth/login` _returns the token, it requires the following body:_
```json
{
"username": "...",
"password": "..."
}
```
Response:
```json
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImRvbWluaWsiLCJzdWIiOjEsImlhdCI6MTY0NTkwNjc5NywiZXhwIjoxNjQ1OTA3Njk3fQ.ayFmmlOSEY6pTxcLATgSO7wf7pWvkpM5lNrYk4WhFdY"
}
```
### Stills
#### GET
`https://domain:3000/stills/uuid` _returns the still as stream, metadata is encoded in headers_
`https://domain:3000/stills/uuid/thumbnail` _returns the thumbnail of the still as stream, metadata is encoded in headers_
`https://domain:3000/stills/` _returns a list of all stills_
Example Response:
```json
[
{
"id": "83f51b91-b66e-49f0-8773-b06b6f613d15",
"hash": "7d3ee0c0bc4fe041b63360ca2bfef583f28f460d2e8ca6f01f357baa2c7d1bcb",
"position": 0
},
{
"id": "84522e61-4294-401c-afda-d27f04512d09",
"hash": "eac318afddd47fc4d8cf6de3579d4cfe28316173dbac3c6906d652fe991d9b38",
"position": 1
},
{
"id": "1d11878c-b31b-4332-aeff-ff2bd43bf269",
"hash": "f7f471ccf608f5868002cb8fb14d557fb03e62ba247c10d177ac68214a4869d9",
"position": 2
},
{
"id": "768c3805-163b-4c96-b18d-a56d92eb5151",
"hash": "5d3d47eb829a7394e5c1e44597397b083e18e7ee14f4dfba289168f5cdb09179",
"position": 3
}
]
```
`https://domain:3000/stills/amount/` _returns the amount of stills_
`https://domain:3000/stills/amount/amount` _returns `amount` stills, starting at position 0 up to `amount-1`_
`https://domain:3000/stills/amount/from/to` _returns `amount` stills, starting at position `from` up to `to`_
#### POST
`https://domain:3000/stills` _uploads a still, the body contains the file, form field label is `file`_
#### DELETE
`https://domain:3000/stills/uuid` _deletes the still with the given uuid_
#### PATCH
`https://doimain:3000/stills/replace`
### Videos
#### GET
`https://domain:3000/videos/uuid` _returns the video as stream_
`https://domain:3000/videos` _returns a list of all videos_
#### POST
`https://domain:3000/videos` _uploads a video in a from, form fields: video, picture1, picture2, picture3, metadata: {url, line1, line2}_
#### DELETE
#### PATCH