update readme

This commit is contained in:
Jurgis Sakalauskas
2023-08-04 16:17:57 +03:00
parent fe938afa3f
commit 16ac4984ba
+24 -26
View File
@@ -4,13 +4,28 @@ An API server for personal [KODI plugin](https://github.com/sakaljurgis/plugin.v
A rewrite attempt from "vanilla" node.js into framework based (Nest.js). A rewrite attempt from "vanilla" node.js into framework based (Nest.js).
## License ## Running the app
No licence
## Migrations
```bash ```bash
$ cp .env.example .env
# edit .env file to match your environment
# make sure all folders exists
# start docker containers
$ docker-compose up -d
```
visit http://localhost:3000/if (or whatever port you have provided in .env file)
kodi plugin should be able to connect to this server with the following settings:
- api url: http://localhost:3000/api
- video url: http://localhost:3000 (video url is old relic from previous versions, it is probably not used anymore)
## Migrations (run inside docker container)
```bash
# enter docker container
docker exec -it kodi-api-server_server_1 bash
# create migration # create migration
$ npm run typeorm:create-migration -name=CreateFilesTable $ npm run typeorm:create-migration -name=CreateFilesTable
@@ -18,27 +33,10 @@ $ npm run typeorm:create-migration -name=CreateFilesTable
$ npm run typeorm:run-migrations $ npm run typeorm:run-migrations
``` ```
## Below are left from nest readme
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test ## Test
this app is not tested 😞 this app is not tested 😞
## License
No licence