Skip to content

Commit 98f5b76

Browse files
author
Cezar Sampaio
committedMay 25, 2020
config: add readme for the project
1 parent f0c0d7d commit 98f5b76

File tree

3 files changed

+75
-1
lines changed

3 files changed

+75
-1
lines changed
 

‎CHANGELOG.md

Whitespace-only changes.

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License
2+
3+
Copyright (c) 2020, Contentful GmbH
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

+54-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,54 @@
1-
# help-center-marketplace-app
1+
# Contentful Knowledge Base Template
2+
3+
![Release](https://github.com/cezarsmpio/help-center-gatsby-template/workflows/Release/badge.svg?branch=master)
4+
5+
> A website template for knowledge base apps powered by Contentful.
6+
7+
## Features
8+
9+
- 🔎 Search
10+
- 🤖 SEO friendly
11+
- ➡️ Contentful preview
12+
- 🛠 Netlify ready
13+
- ⚡️ Performance focused
14+
- 🦾 Accessibility support
15+
- 📱 Responsive support
16+
17+
## Pages
18+
19+
- Homepage
20+
- Categories
21+
- Article
22+
- 404 not found
23+
- Preview articles
24+
25+
![image](https://user-images.githubusercontent.com/954889/82813787-143c4a80-9e96-11ea-84a7-dbe31a1cd26d.png)
26+
27+
## Easiest way to get started
28+
29+
1. Create an account on [contentful.com](https://www.contentful.com/get-started/)
30+
1. Install the [Knowledge Base App](https://www.contentful.com/marketplace/) from Contentful Marketplace
31+
1. Done!
32+
33+
## Making changes locally
34+
35+
1. The `.env.example` file contains the environment variables the project needs
36+
1. Create the `.env.development` and `.env.production` files, one for each environment respectively, and fill up the environment variables
37+
1. Install the dependencies by running `npm ci`
38+
1. `npm start`
39+
40+
## Stack
41+
42+
- Gatsby
43+
- Contentful
44+
- Netlify
45+
46+
## Support
47+
48+
If you have a problem with this template, please file an issue.
49+
50+
If you have other problems with Contentful not related to this project, you can contact [Customer Support](https://support.contentful.com).
51+
52+
## License
53+
54+
[MIT](MIT.md)

0 commit comments

Comments
 (0)
Please sign in to comment.