3.4 Hiding API Keys with Environment Variables (dotenv) and Pushing Code to GitHub

TL;DR

Learn how to hide API keys using environment variables and publish your code on GitHub.

Transcript

[DING] Hello, welcome to another Working With Data and APIs video. And in this video, I'm continuing the Weather Here Project, and I just wanted to one thing. One thing. A very important thing. I want to look at how to stop my API key from just sitting there in my code. I mean, I have something a little bit better here, which is at least the API ke... Read More

Key Insights

• 🔐 Hiding API keys is crucial to prevent unauthorized access and maintain data security.
• 💨 Environment variables offer a secure way to store sensitive information separately from the code.
• 👨‍💻 The dotenv package simplifies the process of loading environment variables into code.
• 📁 The .gitignore file helps exclude sensitive files from being shared on version control platforms like GitHub.
• 🤩 Hiding API keys and publishing code on GitHub are essential steps in securing and sharing projects.
• 📂 Additional precautions such as adding licensing information, a contributing file, and a code of conduct can enhance the openness and collaboration of an open-source project.
• 👨‍💻 Running code off of GitHub is discussed briefly, with the suggestion of exploring it further in the future.

Questions & Answers

Q: Why is it important to hide API keys in code?

Hiding API keys prevents unauthorized access to sensitive information. If exposed, API keys can be abused to gain unauthorized access to resources or data.

Q: How can environment variables be used to hide API keys?

Environment variables allow you to store sensitive information separate from your code, making it more secure. By using packages like dotenv, you can easily load environment variables into your code.

Q: What is the purpose of the .gitignore file?

The .gitignore file specifies files or directories that should not be tracked or uploaded to a git repository. It is used to exclude sensitive or unnecessary files, such as dotenv files or node_modules, from being shared on platforms like GitHub.

Q: What is the recommended convention for storing environment variables?

It is recommended to store environment variables in a dotenv file or through a mechanism provided by the server you're using. The dotenv file convention is commonly followed, but it may vary depending on the platform or framework being used.

Summary & Key Takeaways

• The video discusses the importance of hiding API keys in code and provides a solution using environment variables.

• The dotenv package is introduced as a way to load environment variables from a dotenv file into the code.

• The process of creating a dotenv file, storing the API key in it, and accessing it in the code is explained step-by-step.

• The video also briefly covers how to create a .gitignore file to prevent sensitive files from being uploaded to a GitHub repository.