Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stefanjudis/gatsby-starter-contentful-knowledge-base

Last synced: 18 days ago
JSON representation

Host: GitHub
URL: https://github.com/stefanjudis/gatsby-starter-contentful-knowledge-base
Owner: stefanjudis
License: mit
Created: 2020-07-17T13:48:45.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-01-06T11:45:01.000Z (almost 2 years ago)
Last Synced: 2024-10-15T07:12:57.048Z (about 1 month ago)
Language: JavaScript
Size: 3.28 MB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 28
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Gatsby Starter - Contentful Knowledge Base

![Release](https://github.com/cezarsmpio/help-center-gatsby-template/workflows/Release/badge.svg?branch=master)

> A gatsby starter for knowledge base apps powered by Contentful.

## Features

- 🔎 Search
- 🤖 SEO friendly
- ➡️ Contentful preview
- 🛠 Netlify ready
- ⚡️ Performance focused
- 🦾 Accessibility support
- 📱 Fully responsive
- 🔌 Google Analytics integration

## Pages

- Homepage
- Categories
- Article
- 404 not found
- Preview articles

![image](https://user-images.githubusercontent.com/954889/82813787-143c4a80-9e96-11ea-84a7-dbe31a1cd26d.png)

## Easiest way to get started

1. Create an account on [contentful.com](https://www.contentful.com/get-started/)
1. Install the [Knowledge Base App](https://www.contentful.com/marketplace/) from Contentful Marketplace
1. Done!

## Making changes locally

1. The `.env.example` file contains the environment variables the project needs
1. Create the `.env.development` and `.env.production` files, one for each environment respectively, and fill up the environment variables
1. Install the dependencies by running `npm ci`
1. `npm start`
1. Visit `http://localhost:8000`

## Stack

- Gatsby
- Contentful
- Netlify

## Support

This is a project created for a early access program purposes and not officially supported, so if you find issues or have questions you can let us know via the issue page but don't expect a quick and prompt response.

If you have other problems with Contentful not related to this project, you can contact [Customer Support](https://support.contentful.com).

## License

[MIT](LICENSE.md)