Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tbetous/gridsome-source-conference-hall

Gridsome source plugin to get conference-hall data
https://github.com/tbetous/gridsome-source-conference-hall

conference-hall gridsome gridsome-plugin gridsome-source

Last synced: about 2 months ago
JSON representation

Gridsome source plugin to get conference-hall data

Awesome Lists containing this project

README

        

gridsome-source-conference-hall



Version

Documentation


Maintenance


License: MIT


Twitter: tbetous

> A gridsome plugin to import into graphQL a [conference-hall](https://conference-hall.io/) event

## Install

```bash
# npm
npm install gridsome-source-conference-hall

# yarn
yarn add gridsome-source-conference-hall
```

## Usage

You need to add this plugin to your gridsome project configuration file :

```javascript
// in gridsome.config.js
{
// ...
plugins: [
// ...
{
use: 'gridsome-source-conference-hall',
options: {
apiKey: '',
eventId: ''
}
}
]
}
```

## Configuration

| option name | description |
| ---------------------- | ---------------------------------------------------------------------------- |
| apiKey | The api key generated by conference-all through the event configuration page |
| eventId | The event id of the event |
| filterConfirmedTalks | If true insert only data from confirmed talks |
| convertAbstractsToHtml | Convert talk abstract to HTML |

## Available data

This plugin insert into gridsome graphql all the event data available as exported by the [API](https://contribute-conference-hall.netlify.com/?path=/docs/apis-event--page). You'll find `Event`, `Speaker`, `Category`, `Format` and `Talk` types with all queries generated by gridsome (e.g. `speaker(...)`, `allSpeaker(...)`, `talk(...)`, `allTalk(...)`...).
Do not hesitate to explore data with [GraphQL Playground](https://github.com/prisma-labs/graphql-playground) available from the [Gridsome CLI](https://gridsome.org/docs/gridsome-cli/#explore)

## Author

👤 **Thomas Betous**

- Twitter: [@tbetous](https://twitter.com/tbetous)
- Github: [@tbetous](https://github.com/tbetous)
- LinkedIn: [@tbetous](https://linkedin.com/in/tbetous)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/tbetous/gridsome-source-conference-hall/issues). You can also take a look at the [contributing guide](https://github.com/tbetous/gridsome-source-conference-hall/blob/master/docs/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [tbetous](https://github.com/tbetous).

This project is [MIT](https://github.com/tbetous/gridsome-source-conference-hall/blob/master/LICENSE) licensed.

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_