Mailspring/docs/index.md

---
Title:       First Steps
TitleHidden: True
Section:     Getting Started
Order:       2
---

<style>
h3 {
  line-height: 40px;
  color:#00B883;
}
h3.padded {
  padding-top: 80px;
  padding-bottom: 25px;
}
h3 .number {
  width:40px;
  height:40px;
  margin-right:20px;
  border-radius:50%;
  border:1px solid #00B883;
  float:left;
  color:#00B883;
  text-align: center;
}
h3.first {
  padding-top:40px;
}
h3.second {
  color: #00A180;
}
h3.second .number {
  border:1px solid #00A180;
  color: #00A180;
}
h3.third {
  color: #009899;
}
h3.third .number {
  border:1px solid #009899;
  color: #009899;
}
h4 {
  line-height: 26px;
  font-size: 16px;
  color:#89C9C8;
  margin-top: 30px;
  margin-bottom: 45px;
}
h4 .letter {
  width:22px;
  height:22px;
  margin-right:15px;
  font-size: 14px;
  background-color: #89C9C8;
  float:left;
  color:white;
  text-align: center;
}
p {
  font-size:1.1em;
  line-height: 1.6em;
  color:rgba(0,0,0,0.5);
}
blockquote p {
  font-size: 15px;
}
</style>


<div class="row">
  <div class="col-md-12">
    <h2>Start building on top of Nylas in minutes:</h2>
    <h3 class="first padded"><div class="number">1</div> Install N1</h3>
    <p>Download and install Nylas for <a href="">Mac OS X</a> (or <a href="">Linux</a>). Open it and sign in to your email account.</p>
  </div>
</div>

<div class="row">
  <div class="col-md-8">
    <h3 class="second padded"><div class="number">2</div> Start a Package</h3>
    <p>Packages lie at the heart of N1. The thread list, composer and other core parts of the app are packages bundled with the app, and you have access to the same set of APIs. From the Developer Menu, choose <span class="instruction-literal">Create a Package...</span> and name your new package.</p>
  </div>
  <div class="col-md-4">
    <img src="./images/Step2-Menu@2x.png" width="203" height="194" style="margin-top:88px;"/>
  </div>
</div>

<div class="row">
  <div class="col-md-12">
    <h3 class="third padded"><div class="number">3</div> See it in Action</h3>
    <p>Your new package comes with some basic code that adds a section to the message sidebar, and it's already enabled! View a message to see it in action. If you make changes to the source, choose <span class="instruction-literal">View > Refresh</span> to see your changes in N1.</p>
  </div>
</div>

<hr/>

<div class="row">
  <div class="col-md-12">
    <h2 class="continue"><a href="getting-started-2">Step 2: Build your first package</a></h2>
  </div>
</div>

<hr />

<div class="row">
  <div class="col-md-6" style="padding-right:30px;">
    <h4><div class="letter">A</div> Explore the source</h4>
    <img src="./images/Illu-ExploreTheSource@2x.png" width="121" height="96" style="margin:auto; margin-bottom:35px; display:block;"/>
    <p>Nylas is built on the modern web - packages are written in CoffeeScript or JavaScript. Packages are a lot like node modules, with their own source, assets, and tests. Check out yours in <span class="instruction-literal">~/.nylas/dev/packages</span>.</p>
  </div>
  <div class="col-md-6" style="padding-left:30px;">
    <h4><div class="letter">B</div> Run the specs</h4>
    <img src="./images/illu-RunTheSpecs@2x.png" width="139" height="96" style="margin:auto; margin-bottom:35px; display:block;"/>
    <p>In N1, select <span class="instruction-literal">Developer > Run Package Specs...</span> from the menu to run your package's new specs. Nylas and its packages use the Jasmine testing framework.</p>
  </div>
</div>

<h2 class="gsg-header">Step 3: Building your first package</h2>

If you followed the [first part](getting-started) of our Getting Started Guide, you should have a brand new package just waiting to be explored.

This sample package simply adds the name of the currently focused contact to the sidebar:

<img class="gsg-center" src="images/sidebar-example.png"/>

We're going to build on this to show the sender's [Gravatar](http://gravatar.com) image in the sidebar, instead of just their name. You can check out the full code for the package [in the sample packages repository](https://github.com/nylas/edgehill-plugins/tree/master/sidebar-gravatar).

Find the package source in `~/.nylas/dev/packages` and open the contents in your favorite text editor.

> We use [CJSX](https://github.com/jsdf/coffee-react), a [CoffeeScript](http://coffeescript.org/) syntax for [JSX](https://facebook.github.io/react/docs/jsx-in-depth.html), to streamline our package code.
 For syntax highlighting, we recommend [Babel](https://github.com/babel/babel-sublime) for Sublime, or the [CJSX Language](https://atom.io/packages/language-cjsx) Atom package.

### Changing the data

Let's poke around and change what the sidebar displays.

You'll find the code responsible for the sidebar in `lib/my-message-sidebar.cjsx`. Take a look at the `render` method -- this generates the content which appears in the sidebar.

(How does it get in the sidebar? See [Interface Concepts](interfaceconcepts) and look at `main.cjsx` for clues. We'll dive into this more later in the guide.)

We can change the sidebar to display the contact's email address as well. Check out the [Contact attributes](reference/contact) and change the `_renderContent` method to display more information:

```coffee
_renderContent: =>
  <div className="header">
      <h1>Hi, {@state.contact.name} ({@state.contact.email})!</h1>
  </div>
```

After making changes to the package, reload N1 by going to `View > Reload`.

### Installing a dependency

Now we've figured out how to show the contact's email address, we can use that to generate the [Gravatar](http://gravatar.com) for the contact. However, as per the [Gravatar documentation](https://en.gravatar.com/site/implement/images/), we need to be able to calculate the MD5 hash for an email address first.

Let's install the `md5` package and save it as a dependency in our `package.json`:

```bash
$ npm install md5 --save
```

Installing other dependencies works the same way.

Now, add the `md5` requirement in `my-message-sidebar.cjsx` and update the `_renderContent` method to show the md5 hash:

```coffee
md5 = require 'md5'

class MyMessageSidebar extends React.Component
  @displayName: 'MyMessageSidebar'

  ...

  _renderContent: =>
    <div className="header">
      {md5(@state.contact.email)}
    </div>
```

> JSX Tip: The `{..}` syntax is used for JavaScript expressions inside HTML elements. [Learn more](https://facebook.github.io/react/docs/jsx-in-depth.html).

You should see the MD5 hash appear in the sidebar (after you reload N1):

<img class="gsg-center" src="images/sidebar-md5.png"/>

### Let's Render!

Turning the MD5 hash into a Gravatar image is simple. We need to add an `<img>` tag to the rendered HTML:

```coffee
_renderContent =>
    <div className="header">
      <img src={'http://www.gravatar.com/avatar/' + md5(@state.contact.email)}/>
    </div>
```

Now the Gravatar image associated with the currently focused contact appears in the sidebar. If there's no image available, the Gravatar default will show; you can [add parameters to your image tag](https://en.gravatar.com/site/implement/images/) to change the default behavior.

<img class="gsg-center" src="images/sidebar-gravatar.png"/>


### Styling

Adding styles to our Gravatar image is a matter of editing `stylesheets/main.less` and applying the class to our `img` tag. Let's make it round:

<div class="filename">stylesheets/main.less</div>
```css
.gravatar {
    border-radius: 45px;
    border: 2px solid #ccc;
}
```

<div class="filename">lib/my-message-sidebar.cjsx</div>
```coffee
_renderContent =>
    gravatar = "http://www.gravatar.com/avatar/" + md5(@state.contact.email)

    <div className="header">
      <img src={gravatar} className="gravatar"/>
    </div>
```

> React Tip: Remember to use DOM property names, i.e. `className` instead of `class`.

You'll see these styles reflected in your sidebar.

<img class="gsg-center" src="images/sidebar-style.png"/>

If you're a fan of using the Chrome Developer Tools to tinker with styles, no fear; they work in N1, too. Open them by going to `Developer > Toggle Developer Tools`. You'll also find them helpful for debugging in the event that your package isn't behaving as expected.

<hr/>

<h2 class="continue"><a href="getting-started-3">Continue this guide: adding a data store to your package</a></h2>

<hr/>


<h2 class="gsg-header">Step 4: Adding a Data Store</h2>

Building on the [previous part](getting-started-2) of our Getting Started guide, we're going to introduce a data store to give our sidebar superpowers.

## Stores and Data Flow

The Nylas data model revolves around a central `DatabaseStore` and lightweight `Models` that represent data with a particular schema. This works a lot like ActiveRecord, SQLAlchemy and other "smart model" ORMs. See the [Database](database) explanation for more details.

Using the [Flux pattern](https://facebook.github.io/flux/docs/overview.html#structure-and-data-flow) for data flow means that we set up our UI components to 'listen' to specific data stores. When those stores change, we update the state inside our component, and re-render the view.

We've already used this (without realizing) in the [Gravatar sidebar example](getting-started-2):

```coffee
  componentDidMount: =>
    @unsubscribe = FocusedContactsStore.listen(@_onChange)
  ...
  _onChange: =>
    @setState(@_getStateFromStores())

  _getStateFromStores: =>
    contact: FocusedContactsStore.focusedContact()
```

In this case, the sidebar listens to the `FocusedContactsStore`, which updates when the person selected in the conversation changes. This triggers the `_onChange` method which updates the component state; this causes React to render the view with the new state.

To add more depth to our sidebar package, we need to:

* Create our own data store which will listen to `FocusedContactsStore`
* Extend our data store to do additional things with the contact data
* Update our sidebar to listen to, and display data from, the new store.

In this guide, we'll fetch the GitHub profile for the currently focused contact and display a link to it, using the [GitHub API](https://developer.github.com/v3/search/).

## Creating the Store

The boilerplate to create a new store which listens to `FocusedContactsStore` looks like this:

<div class="filename">lib/github-user-store.coffee</div>
```coffee
Reflux = require 'reflux'
{FocusedContactsStore} = require 'nylas-exports'

module.exports =

GithubUserStore = Reflux.createStore

  init: ->
      @listenTo FocusedContactsStore, @_onFocusedContactChanged

  _onFocusedContactChanged: ->
      # TBD - This is fired when the focused contact changes
      @trigger(@)
```

(Note: You'll need to set up the `reflux` dependency.)

You should be able to drop this store into the sidebar example's `componentDidMount` method -- all it does is listen for the `FocusedContactsStore` to change, and then `trigger` its own event.

Let's build this out to retrieve some new data based on the focused contact, and expose it via a UI component.

## Getting Data In

We'll expand the `_onFocusedContactChanged` method to do something when the focused contact changes. In this case, we'll see if there's a GitHub profile for that user, and display some information if there is.

```coffee
request = require 'request'

GithubUserStore = Reflux.createStore
  init: ->
    @_profile = null
    @listenTo FocusedContactsStore, @_onFocusedContactChanged

  getProfile: ->
    @_profile

  _onFocusedContactChanged: ->
    # Get the newly focused contact
    contact = FocusedContactsStore.focusedContact()
    # Clear the profile we're currently showing
    @_profile = null    
    if contact
      @_fetchGithubProfile(contact.email)
    @trigger(@)

  _fetchGithubProfile: (email) ->
    @_makeRequest "https://api.github.com/search/users?q=#{email}", (err, resp, data) =>
      console.warn(data.message) if data.message?
      # Make sure we actually got something back
      github = data?.items?[0] ? false
      if github
        @_profile = github
        console.log(github)
    @trigger(@)

  _makeRequest: (url, callback) ->
    # GitHub needs a User-Agent header. Also, parse responses as JSON.
    request({url: url, headers: {'User-Agent': 'request'}, json: true}, callback)
```

The `console.log` line should show the GitHub profile for a contact (if they have one!) inside the Developer Tools Console, which you can enable at `Developer > Toggle Developer Tools`.

You may run into rate-limiting issues with the GitHub API; to avoid these, you can add [authentication](https://developer.github.com/v3/#authentication) with a [pre-baked token](https://github.com/settings/tokens) by modifying the HTTP request your store makes. **Caution! Use this for local development only.** You could also try implementing a simple cache to avoid making the same request multiple times.

## Display Time

To display this new data in the sidebar, we need to make sure our component is listening to the store, and load the appropriate state when it changes.

```coffee
class GithubSidebar extends React.Component
  ...
  componentDidMount: =>
    @unsubscribe = GithubUserStore.listen(@_onChange)

  _onChange: =>
    @setState(@_getStateFromStores())

  _getStateFromStores: =>
    github: GithubUserStore.getProfile()
```

Now we can access `@state.github` (which is the GitHub user profile object), and display the information it contains by updating the `render` and `renderContent` methods.

For example:

```coffee
  _renderContent: =>
    <img className="github" src={@state.github.avatar_url}/> <a href={@state.github.html_url}>GitHub</a>
```

## Extending The Store

To make this package more compelling, we can extend the store to make further API requests and fetch more data about the user. Passing this data back to the UI component follows exactly the same pattern as the barebones data shown above, so we'll leave it as an exercise for  the reader. :)

> You can find a more extensive version of this example in our [sample packages repository](https://github.com/nylas/edgehill-plugins/tree/master/sidebar-github-profile).