-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 834a68b
Showing
36 changed files
with
14,779 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{ | ||
presets: [ | ||
[ | ||
"@babel/preset-env", | ||
{ | ||
loose: true, | ||
modules: false, | ||
useBuiltIns: "usage", | ||
shippedProposals: true, | ||
targets: { | ||
browsers: [">0.25%", "not dead"], | ||
}, | ||
}, | ||
], | ||
[ | ||
"@babel/preset-react", | ||
{ | ||
useBuiltIns: true, | ||
pragma: "React.createElement", | ||
}, | ||
], | ||
], | ||
plugins: [ | ||
[ | ||
"@babel/plugin-proposal-class-properties", | ||
{ | ||
loose: true, | ||
}, | ||
], | ||
"@babel/plugin-syntax-dynamic-import", | ||
"babel-plugin-macros", | ||
[ | ||
"@babel/plugin-transform-runtime", | ||
{ | ||
helpers: true, | ||
regenerator: true, | ||
}, | ||
], | ||
], | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"spaceId": "...", | ||
"accessToken": "..." | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
module.exports = { | ||
"env": { | ||
"browser": true, | ||
"es6": true, | ||
}, | ||
"plugins": [ | ||
"react", | ||
], | ||
"globals": { | ||
"graphql": false, | ||
}, | ||
"parserOptions": { | ||
"sourceType": "module", | ||
"ecmaFeatures": { | ||
"experimentalObjectRestSpread": true, | ||
"jsx": true, | ||
}, | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (http://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Typescript v1 declaration files | ||
typings/ | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variables file | ||
.env | ||
|
||
# build folder | ||
public | ||
|
||
# gatsby cache folder | ||
.cache | ||
|
||
# contentful config file | ||
.contentful.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"trailingComma": "es5", | ||
"semi": false, | ||
"singleQuote": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
language: node_js | ||
|
||
os: | ||
- linux | ||
- osx | ||
|
||
node_js: | ||
- "node" | ||
- "lts/*" | ||
- "7" | ||
- "8" | ||
|
||
script: | ||
- npm install | ||
- npm run lint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# gatsby-contentful-starter | ||
|
||
Gatsby [Contentful](https://www.contentful.com) starter for creating a blog | ||
|
||
![The index page of the starter blog](https://rawgit.com/contentful-userland/gatsby-contentful-starter/master/screenshot.jpg "The index page of the starter blog") | ||
|
||
Static sites are scalable, secure and have very little required maintenance. They come with a drawback though. Not everybody feels good editing files, building a project and uploading it somewhere. This is where Contentful comes into play. | ||
|
||
With Contentful and Gatsby you can connect your favorite static site generator with an API that provides an easy to use interface for people writing content and automate the publishing using services like [Travis CI](https://travis-ci.org/) or [Netlify](https://www.netlify.com/). | ||
|
||
## Features | ||
|
||
* Simple content model and structure. Easy to adjust to your needs. | ||
* Contentful integration using our [Sync API](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization/initial-synchronization-of-entries-of-a-specific-content-type) | ||
* Using our [Delivery API](https://www.contentful.com/developers/docs/references/content-delivery-api/). | ||
* Responsive/adaptive images via [gatsby-image](https://www.gatsbyjs.org/packages/gatsby-image/) | ||
|
||
## Contribution | ||
|
||
This project is part of [contentful-userland](https://github.com/contentful-userland) which means that we’re always open to contributions **and you can be part of userland and shape the project yourself after your first merged pull request**. You can learn more about how contentful userland is organized by visiting [our about repository](https://github.com/contentful-userland/about). | ||
|
||
## Requirements | ||
|
||
To use this project you have to have a Contentful account. If you don't have one yet you can register at [www.contentful.com/sign-up](https://www.contentful.com/sign-up/). | ||
|
||
## Getting started | ||
|
||
Install [Yarn](https://yarnpkg.com/en/docs/install) (if you haven't already). | ||
|
||
### Get the source code and install dependencies. | ||
|
||
``` | ||
$ git clone git@github.com:contentful-userland/gatsby-contentful-starter.git | ||
$ yarn install | ||
``` | ||
|
||
Or use the [Gatsby CLI](https://www.npmjs.com/package/gatsby-cli). | ||
|
||
``` | ||
$ gatsby new contentful-starter https://github.com/contentful-userland/gatsby-contentful-starter | ||
``` | ||
|
||
### Set up of the needed content model and create a configuration file | ||
|
||
This project comes with a Contentful setup command `yarn run setup`. | ||
|
||
![Command line dialog of the yarn run setup command](https://rawgit.com/contentful-userland/gatsby-contentful-starter/master/setup.jpg "Command line dialog of the yarn run setup command") | ||
|
||
This command will ask you for a space ID, and access tokens for the Contentful Management and Delivery API and then import the needed content model into the space you define and write a config file (`./contentful.json`). | ||
|
||
`yarn run setup` automates that for you but if you want to do it yourself rename `.contentful.json.sample` to `.contentful.json` and add your configuration in this file. | ||
|
||
## Crucial Commands | ||
|
||
This project comes with a few handy commands for linting and code fixing. The most important ones are the ones to develop and ship code. You can find the most important commands below. | ||
|
||
### `yarn run dev` | ||
|
||
Run in the project locally. | ||
|
||
### `yarn run build` | ||
|
||
Run a production build into `./public`. The result is ready to be put on any static hosting you prefer. | ||
|
||
### `yarn run deploy` | ||
|
||
Run a production build into `./public` and publish the site to GitHub pages. | ||
|
||
### `yarn run cleanup-repository` | ||
|
||
Removes all dependencies, scripts and data from the installation script. | ||
|
||
## Roadmap | ||
|
||
- [x] [make the starter completely responsive](https://github.com/contentful-userland/gatsby-contentful-starter/issues/2) | ||
- [ ] [include tags](https://github.com/contentful-userland/gatsby-contentful-starter/issues/3) | ||
- [x] [support traced placeholders](https://github.com/contentful-userland/gatsby-contentful-starter/issues/4) | ||
- [ ] [add i18n](https://github.com/contentful-userland/gatsby-contentful-starter/issues/6) | ||
|
||
## Other resources | ||
|
||
- Tutorial video series ["Building a blazing fast website with GatsbyJS and Contentful"](https://www.youtube.com/watch?v=Ek4o40w1tH4&list=PL8KiuH6vpACV-F7jXribe4YveGBhBeG9A) by @Khaledgarbaya |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"name": "Contentful Gatsby Starter", | ||
"description": "Gatsby starter for a Contentful project.", | ||
"keywords": [ | ||
"contentful", | ||
"gatsby", | ||
"static", | ||
"ssg" | ||
], | ||
"repository": "https://github.com/contentful-userland/gatsby-contentful-starter", | ||
"success_url": "/", | ||
"buildpacks": [ | ||
{ | ||
"url": "heroku/nodejs" | ||
}, | ||
{ | ||
"url": "https://github.com/heroku/heroku-buildpack-static" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
const chalk = require('chalk') | ||
const pkg = require('../package.json') | ||
|
||
console.log(` | ||
${chalk.green('Hey there! 👋')} | ||
Thanks for giving the ${pkg.name} a try. 🎉 | ||
To get you going really quickly this project includes a setup step. | ||
${chalk.yellow.bold('yarn run setup')} automates the following steps for you: | ||
- creates a config file ${chalk.yellow('./.contentful.json')} | ||
- imports ${chalk.green('a predefined content model')} | ||
When this is done run: | ||
${chalk.yellow( | ||
'yarn run dev' | ||
)} to start a development environment at ${chalk.green('localhost:8000')} | ||
or | ||
${chalk.yellow( | ||
'yarn run build' | ||
)} to create a production ready static site in ${chalk.green('./public')} | ||
For further information check the readme of the project | ||
(https://github.com/contentful-userland/gatsby-contentful-starter) | ||
`) |
Oops, something went wrong.