Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates readme to better describe after setup process #158

Closed
wants to merge 1 commit into from
Closed

Updates readme to better describe after setup process #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .contentful.json.sample
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions .env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CONTENTFUL_SPACE_ID='...'
CONTENTFUL_ACCESS_TOKEN='...'
6 changes: 5 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,8 @@ public
# contentful config file
.contentful.json
# Local Netlify folder
.netlify
.netlify

# enviornment files created by `npm run setup`
.env.*
!.env.sample
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ $ gatsby new contentful-starter-blog https://github.com/contentful/starter-gatsb

This project comes with a Contentful setup command `npm run setup`.

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`).
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 files (`.env.production` and `.enf.development`).

`npm 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.
`npm run setup` automates that for you but if you want to do it yourself rename `.env.sample` to `.env.development` and add your configuration in this file.

## Crucial Commands

Expand Down