diff options
| author | Ritesh Ghosh <[email protected]> | 2023-11-29 21:20:14 +0530 |
|---|---|---|
| committer | Ritesh Ghosh <[email protected]> | 2023-11-29 21:20:14 +0530 |
| commit | 3ac10be9128780bcde70ddafca886814e2021e7f (patch) | |
| tree | 8e46bbaf64fa92b43689e1d6b9115eedce349a70 | |
| parent | 0b9194e9194e790d40ebef1c76366cea190546cd (diff) | |
| download | aniwatch-api-3ac10be9128780bcde70ddafca886814e2021e7f.tar.xz aniwatch-api-3ac10be9128780bcde70ddafca886814e2021e7f.zip | |
docs: add vercel deployment button
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -82,6 +82,8 @@ - [Installation](#installation) - [Local](#local) - [Docker](#docker) +- [Host your instance](#host-your-instance) + - [Vercel](#vercel) - [Documentation](#documentation) - [GET Anime Home Page](#get-anime-home-page) - [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. +## <span id="host-your-instance">⛅ Host your instance</span> + +### Vercel + +[](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> 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. |