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

https://github.com/laravel-notification-channels/website

Laravel Notifications Channel Website
https://github.com/laravel-notification-channels/website

Last synced: 8 months ago
JSON representation

Laravel Notifications Channel Website

Awesome Lists containing this project

README

          

# Laravel Notification Channels Website

Our site is built with [Vuepress](https://vuepress.vuejs.org/).

## Building

```bash
yarn dev # Run developmnent server
yarn build # Build the static site
```

## Adding new Channels

Open `channels.js` and add your channel to the correct category. The slug should be set as the github repository name.
`maintainers` is a list of github usernames that maintain the channel (they appear in the header of the channel page on the website)

This will add the channel to the sidebar, and pull in the `README.md` from the repository during the build.

```js
...

name: 'Support', channels: [
{
slug: 'pagerduty', name: 'Pagerduty',
maintainers: ['atymic'],
},
{
slug: 'intercom', name: 'Intercom',
maintainers: ['ftw-soft'],
},
],

...
```

## Deploying
This website is deployed automatically using [Netlify](https://app.netlify.com).

The website is built on each commit and automatically once per day to pull in updates from the provider repos.

## Contribution

Contributions are welcome. Feel free to create an Issue or PR.