Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabe/gatsby-plugin-drive
🚗 Downloads a Google Drive folder that you can query with gatsby-source-filesystem.
https://github.com/fabe/gatsby-plugin-drive
gatsby gatsby-plugin google-drive
Last synced: 2 months ago
JSON representation
🚗 Downloads a Google Drive folder that you can query with gatsby-source-filesystem.
- Host: GitHub
- URL: https://github.com/fabe/gatsby-plugin-drive
- Owner: fabe
- License: mit
- Created: 2018-07-31T13:51:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T18:12:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-17T16:02:40.213Z (3 months ago)
- Topics: gatsby, gatsby-plugin, google-drive
- Language: JavaScript
- Homepage: https://npm.im/@fs/gatsby-plugin-drive
- Size: 307 KB
- Stars: 12
- Watchers: 4
- Forks: 15
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gatsby-plugin-drive
Downloads and caches a Google Drive folder that you can then query with `gatsby-source-filesystem`.
Optionally exports Google Docs to a usable format.
## Installation
```bash
yarn add @fs/gatsby-plugin-drive
```
## Usage
In order to use this plugin, you'll need to generate a Google Service Account and share your drive folder with its email. [Here's a guide](https://www.twilio.com/blog/2017/03/google-spreadsheets-and-javascriptnode-js.html).
```js
// In your gatsby-config.js
plugins: [
{
resolve: '@fs/gatsby-plugin-drive',
options: {
folderId: 'GOOGLE_DRIVE_FOLDER_ID',
keyFile: path.resolve(__dirname, 'YOUR_SERVICE_ACCOUNT_KEYFILE.json'),
destination: path.join(__dirname, 'src/content'),
pageSize: 100,
exportGDocs: true,
exportMimeType: 'text/html',
exportMiddleware: someFunction
}
}
]
// Or using environment variables
plugins: [
{
resolve: '@fs/gatsby-plugin-drive',
options: {
folderId: process.env.GOOGLE_DRIVE_FOLDER_ID,
key: {
private_key: process.env.GOOGLE_PRIVATE_KEY,
client_email: process.env.GOOGLE_CLIENT_EMAIL,
},
destination: path.join(__dirname, 'src/content'),
pageSize: 100,
exportGDocs: true,
exportMimeType: 'text/html',
exportMiddleware: someFunction
}
}
]
```
If the `exportGDocs` option is enabled, all Google Docs in the folder will be exported with the MIME type set in the `exportMimeType` option. You can see a list of available Google Docs export MIME types [here](https://developers.google.com/drive/api/v3/manage-downloads).
If the `exportGDocs` option is disabled, all Google Docs in the folder will be ignored.
The `exportMiddleware` option is optional. If set, the plugin will run each Google Doc through the function, before it writes it to disk.
A usecase for this, could be cleaning up, or manipulating, the HTML that the Google Drive API returns.
The expected function signature is `Buffer -> Buffer`.
Your drive folder will download all files everytime it builds, except when a file already exists or is cached. To download all files again, set up an npm clean script like:
```json
"clean": "rimraf src/content",
```
## Rate Limiting
The default amount of allowed requests per user per 100 seconds is `1,000`. If you're planning to download a large folder with this plugin, you might have to increase this limit. To do that, open the "Services" tab in the Google Cloud Console, select "Google Drive API" and change the limit under ["Quotas"](https://console.developers.google.com/apis/api/drive.googleapis.com/quotas).
By default, this plugin downloads 100 files per folder at most. If you require a larger limit, pass in a higher value to the `pageSize` option.
## Author
* Fabian Schultz ([@fschultz\_](https://twitter.com/fschultz_)) - [Stink Studios](https://stinkstudios.com)
* Elias Jørgensen ([@\_eliasjorgensen](https://twitter.com/_eliasjorgensen))