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

docs: add vercel deployment button

Browse Source
This commit is contained in:
Ritesh Ghosh
2023-11-29 21:20:14 +05:30
parent 0b9194e919
commit 3ac10be912
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12
View File
@@ -82,6 +82,8 @@
- [Installation](#installation) - [Installation](#installation)
- [Local](#local) - [Local](#local)
- [Docker](#docker) - [Docker](#docker)
- [Host your instance](#host-your-instance)
- [Vercel](#vercel)
- [Documentation](#documentation) - [Documentation](#documentation)
- [GET Anime Home Page](#get-anime-home-page) - [GET Anime Home Page](#get-anime-home-page)
- [GET Anime About Info](#get-anime-about-info) - [GET Anime About Info](#get-anime-about-info)
@@ -138,6 +140,16 @@ The above command will start the server on port 4000. You can access the server
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="host-your-instance">⛅ Host your instance</span>
### Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/ghoshRitesh12/aniwatch-api)
> [!NOTE]
>
> When deploying to vercel, set an env named `IS_VERCEL_DEPLOYMENT` to `true` or anything, but this env should be present.
## <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.