From 3ac10be9128780bcde70ddafca886814e2021e7f Mon Sep 17 00:00:00 2001 From: Ritesh Ghosh Date: Wed, 29 Nov 2023 21:20:14 +0530 Subject: docs: add vercel deployment button --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index bec1e05..ae07c2a 100644 --- a/README.md +++ b/README.md @@ -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. +## ⛅ Host your instance + +### 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. + ## 📚 Documentation 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. -- cgit v1.2.3