Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/molebox/gatsby-theme-testimonials

A Gatsby theme that adds a testimonial section to your website
https://github.com/molebox/gatsby-theme-testimonials

Last synced: 9 days ago
JSON representation

A Gatsby theme that adds a testimonial section to your website

Awesome Lists containing this project

README

        

# gatsby-theme-testimonials

This is Gatsby theme to add customer testimonials to your website. The testimonial cards are exported as a section to just insert into your JSX. You add the data to be displayed via json files located in a testimonials folder at your projects root. This file will be created for you when you install the theme if you don't add it yourself.

The default styling is [neumorphism](https://uxdesign.cc/neumorphism-in-user-interfaces-b47cef3bf3a6), this can be overriden by shadowing the TestimonialCard component.

Example of how this looks in practice: [https://gatsby-theme-testimonials.netlify.com/](https://gatsby-theme-testimonials.netlify.com/)

## Setup

Install the theme with either yarn `yarn add gatsby-theme-testimonials` or npm `npm i gatsby-theme-testimonials`

Add it to your `gatsby-config.js`

```js
module.exports = {
plugins: [
'gatsby-theme-testimonials'
]
}
```

The testimonials folder will be created at your projects root on first run, but otherwise you can create that folder.

The expected json format for each file is like this:

```json
{
"name": "Carol Danvers",
"company": "Marveless Wordpress",
"blurb": "I’ve been fighting with one arm tied behind my back, but what happens when I’m finally set free?",
"twitter": "https://twitter.com/studio_hungry",
"linkedIn": "https://www.linkedin.com/in/richard-haines-578464176/"
}
```

The naming of the file is up to you, i suggest naming them after the author of the testimonial.

The twitter and linkedIn links can be skipped if none are supplied by the testimonial author, the cards will render both, one or none depending on if you set them in the json file.

Import the `TestimonialSection` from the theme and insert it anywhere in your JSX

```jsx
import React from 'react';
import {TestimonialSection} from 'gatsby-theme-testimonials';

export default () => (

Some section of your website



Some other section of your website

);
```

## Built With

- [Gatsby](https://www.gatsbyjs.org/)
- [Emotion](https://emotion.sh/docs/introduction)
- [Theme-UI](https://theme-ui.com/)

## Authors

- **Rich Haines** - _Hungry Bear Studio_

## License

This project is licensed under the MIT License