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

Add a .env_sample file, update README.md #245

Merged
merged 2 commits into from
Oct 30, 2017
Merged

Add a .env_sample file, update README.md #245

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07cfc22
Add a .env_sample file, update README.md
thepriefy Oct 27, 2017
11926ac
remove duplicate section
thepriefy Oct 29, 2017
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
1 change: 1 addition & 0 deletions .env_sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export SENDGRID_API_KEY=''
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,24 @@ gem install sendgrid-ruby
- [Ruby-HTTP-Client](https://github.com/sendgrid/ruby-http-client)
- [Sinatra](http://www.sinatrarb.com/) - this is only needed if you plan to process [Inbound Email](#inbound).

## Setup Environment Variables

### Initial Setup

```bash
cp .env_sample .env
Copy link

Choose a reason for hiding this comment

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

If you are doing this step, then all you need to do is open and edit the file by inserting your API KEY.

The next section environment variable is redundant.

```

### Environment Variable

Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example:

```bash
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
```

<a name="quick-start"></a>
# Quick Start

Expand Down