Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f00b4r/strapi-plugin-vercel
▲ Strapi plugin for Vercel Platform
https://github.com/f00b4r/strapi-plugin-vercel
deployment plugin strapi strapi-plugin vercel webkitty
Last synced: about 1 month ago
JSON representation
▲ Strapi plugin for Vercel Platform
- Host: GitHub
- URL: https://github.com/f00b4r/strapi-plugin-vercel
- Owner: f00b4r
- License: mit
- Created: 2020-11-16T15:37:23.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-27T17:33:12.000Z (over 2 years ago)
- Last Synced: 2024-09-30T18:17:55.532Z (3 months ago)
- Topics: deployment, plugin, strapi, strapi-plugin, vercel, webkitty
- Language: JavaScript
- Homepage:
- Size: 937 KB
- Stars: 28
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Strapi Plugin Vercel
List deployments and deploy directly from Strapi.
🕹 f3l1x.io | 💻 f3l1x | 🐦 @xf3l1x
-----
## Usage
To install latest version use [NPM](https://npmjs.com).
```
npm install --save strapi-plugin-vercel
```
## Versions
| State | Version | Strapi |
| ------ | -------- | ------ |
| dev | `dev` | `4.x` |
| stable | `^0.0.7` | `3.x` |
## Overview
If you want to use [Vercel](https://vercel.com) as a platform for your website built on Strapi, you need to tell Vercel when to rebuild your site.
Of course, you can use webhook, but it can trigger a lot of pipelines. With this plugin, you will have a recreation of the vercel dashboard on
your strapi dashboard, with which you can easily trigger deploys.
This plugin solves:
- manual triggering deployment to Vercel
- list of latest deployments
- current status of deployment
## Documentation
1. Install plugin.
2. Edit configuration.
#### `{strapi}/config/server.js`
There must be root key `vercel`.
```js
module.exports = ({ env }) => ({
{
...
},
vercel: {
// Required
token: env('VERCEL_TOKEN'),
// Required
projectId: env('VERCEL_PROJECT_ID'),
// Optional (required if you use teams)
teamId: env('VERCEL_TEAM_ID'),
// Required (hooks)
triggers: {
production: env('VERCEL_TRIGGER_PRODUCTION')
},
// Optional
config: {
// Number of latest deployments
deployments: 10
}
}
});
```
#### Token
Token is required.
Generate token on `https://vercel.com/account/tokens`. You should set the scope to your team.
#### Team ID
Team ID is optional, but if you set team's scope to your token, than you should provide team ID.
You can find it on your team's settings page: https://vercel.com/teams/{team}/settings.
It should begin with `team_...`. If you use personal account, you don't need it.
#### Project ID
Project ID is required.
You can find it on your projects's settings page: hhttps://vercel.com/{team}/{project}/settings
It should begin with `prj_...`. If you use personal account, you still need it.
#### Trigger
Trigger (deploy hook) is required.
You can generate it on your projects's settings git page: hhttps://vercel.com/{team}/{project}/settings/git
```
https://api.vercel.com/v1/integrations/deploy/abcdefghijklm/vwxyzvwxyzzz/
| ^^ ^^
| / project id / hook id /
```
Copy only hook id.
3. Edit administration section. Create these directories if you don't have them yet.
#### `{strapi}/admin/src/containers/HomePage/index.js`
```js
import React, { memo } from "react";
import { Padded } from "@buffetjs/core";
import { Header } from "@buffetjs/custom";
import { Deployments, DeployButton } from "./../../../../plugins/strapi-plugin-vercel/admin/src/view";
const Dashboard = () => {
return (
<>
>
);
};
export default memo(Dashboard);
```
4. Profit 🚀
## Development
-----
Consider to [support](https://github.com/sponsors/f3l1x) **f3l1x**. Also thank you for using this package.