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

Jump to bottom

Instructions on how to start the project locally is out of date #9

Closed
chadfawcett opened this issue Oct 16, 2018 · 4 comments
Closed

Instructions on how to start the project locally is out of date #9

chadfawcett opened this issue Oct 16, 2018 · 4 comments
Labels
enhancement New feature or request

Comments

@chadfawcett
Copy link
Contributor

  • Clone url is out of date/invalid
  • Might be worthwhile explaining the environment variables needed

https://github.com/gatsbyjs/api.gatsbyjs.org/blob/f2d7f845b162ed5f9d75bc7d5f1c99c31f56bb39/README.md#step-1-start-the-api-locally
@jlengstorf
Copy link
Contributor

Good call. Will add this to the TODO list.

@jlengstorf jlengstorf added the enhancement New feature or request label Oct 16, 2018
@PSalant726 PSalant726 mentioned this issue Oct 17, 2018
Merged
@PSalant726
Copy link
Contributor

@chadfawcett Can you provide more detail re: the env variables you want documented?

@chadfawcett
Copy link
Contributor Author

Well the README doesn't mention anything about the .env.EXAMPLE file. I think each variable should at least have a short description, if not a step by step guide on acquiring them (getting github and shopify tokens, etc).

@PSalant726
Copy link
Contributor

Ok, I added a table with some short variable descriptions. I did the best I could with limited context. Definitely open to feedback on the PR!

jlengstorf pushed a commit that referenced this issue Oct 20, 2018
@PSalant726 @jlengstorf
docs: Update README (#10)
4992635 
- Update clone URL
- Add link to test `cURL` command
- Format Step 4 heading
- Add Step 3, `env` variables and descriptions

Fixes #9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jlengstorf @chadfawcett @PSalant726