shishantbiswas/aniwatch-api
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style: linting change

Browse Source
This commit is contained in:
Ritesh Ghosh
2023-08-19 23:45:52 +05:30
parent 471c02bf3d
commit 028064ea5d
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -12
View File
@@ -115,23 +115,25 @@
``` ```
Now the server should be running on [http://localhost:4000](http://localhost:4000) Now the server should be running on [http://localhost:4000](http://localhost:4000)
### Docker ### Docker
Docker image is available at [GitHub Container Registry](https://github.com/ghoshRitesh12/aniwatch-api/pkgs/container/aniwatch). Docker image is available at [GitHub Container Registry](https://github.com/ghoshRitesh12/aniwatch-api/pkgs/container/aniwatch).
Run the following command to pull and run the docker image. Run the following commands to pull and run the docker image.
```bash
docker pull ghcr.io/ghoshritesh12/aniwatch ```bash
docker run -p 4000:4000 ghcr.io/ghoshritesh12/aniwatch docker pull ghcr.io/ghoshritesh12/aniwatch
``` docker run -p 4000:4000 ghcr.io/ghoshritesh12/aniwatch
```
The above command will start the server on port 4000. You can access the server at [http://localhost:4000](http://localhost:4000) and you can also change the port by changing the `-p` option to `-p <port>:4000`. The above command will start the server on port 4000. You can access the server at [http://localhost:4000](http://localhost:4000) and you can also change the port by changing the `-p` option to `-p <port>:4000`.
You can also add the `-d` flag to run the container in detached mode. You can also add the `-d` flag to run the container in detached mode.
## <span id="documentation">📚 Documentation</span> ## <span id="documentation">📚 Documentation</span>
The endpoints exposed by the api are listed below with examples that uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), but you can use any http library. The endpoints exposed by the api are listed below with examples that uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), but you can use any http library.
### `GET` Anime Home Page ### `GET` Anime Home Page
@@ -724,11 +726,11 @@ http://localhost:4000/anime/episode-srcs?id={episodeId}&server={server}&category
#### Query Parameters #### Query Parameters
| Parameter | Type | Description | Required? | Default | | Parameter | Type | Description | Required? | Default |
| :---------: | :----: | :-------------------------------------------: | :-------: | :------------: | | :--------: | :----: | :-------------------------------------------: | :-------: | :--------------: |
| `id` | string | The id of the episode. | Yes | -- | | `id` | string | The id of the episode. | Yes | -- |
| `server` | string | The name of the server. | No | `"vidstreaming"` | | `server` | string | The name of the server. | No | `"vidstreaming"` |
| `category` | string | The category of the episode ('sub' or 'dub'). | No | `"sub"` | | `category` | string | The category of the episode ('sub' or 'dub'). | No | `"sub"` |
#### Request sample #### Request sample