Skip to content

Updating README#49

Open
junocchi wants to merge 1 commit intomainfrom
update/readme
Open

Updating README#49
junocchi wants to merge 1 commit intomainfrom
update/readme

Conversation

@junocchi
Copy link
Contributor

No description provided.

Copy link
Collaborator

@pablisch pablisch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Ju, great to tidy things up a bit. Just have a few questions about the README.md content. If the nodemon and react-allergens stuff is still needed, then fair enough, just let me know. The standard React documentation will need minor edits if kept to allow for the README's new root folder location

npm install
```

3. Ensure nodemon is installed by running
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a known issue here with nodemon? I did note that nodemon is listed as a dependency where I believe it should be a dev dependency which could potentially be an issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, yesterday we noticed nodemon appearing in a few error messages. We might need to update it to be a dev dependency then.

npm install nodemon --global
```

4. Install the "react-allergens" package using the package manager of your choice, such as npm or yarn.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to nodemon, but why do we need this when it is already a dependency? Is there any known issue here? If there is then we should be expected to have a production issue with it.

- [Keeping your API keys secret with dotenv](https://jonathansoma.com/lede/foundations-2019/classes/apis/keeping-api-keys-secret/)
- [dotenv](https://www.npmjs.com/package/dotenv)

# Getting Started with Create React App
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm all in favour of ditching the default React App documentation as it feels like unnecessary information for this project. If we are keeping it then line 98, "In the project directory, you can run:" is no longer true and line 100, "### npm start" is repetition.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Another thing we added yesterday was to set our ‘OPENAI_API_KEY’ Environment Variable using zsh:

  1. Run the following command in your terminal, replacing yourkey with your API key.

echo "export OPENAI_API_KEY='yourkey'" >> ~/.zshrc

  1. Update the shell with the new variable:

source ~/.zshrc

  1. Confirm that you have set your environment variable using the following command.

echo $OPENAI_API_KEY
The value of your API key will be the resulting output.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will make the changes and let you know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments