mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-01 13:14:16 +08:00
22 lines
2.2 KiB
HTML
22 lines
2.2 KiB
HTML
---
|
|
layout: docs
|
|
title: FAQ
|
|
edit_url: "https://github.com/nylas/N1/blob/a2c697754ad692e6a54629ffd93883dda79b0d78/docs/FAQ.md"
|
|
---
|
|
<h3 id="do-i-have-to-use-react-">Do I have to use React?</h3>
|
|
<p>The short answer is yes, you need to use React. The <a href='componentregistry.html'>ComponentRegistry</a> expects React components, so you'll need to create them to extend the N1 interface.</p>
|
|
<p>However, if you have significant code already written in another framework, like Angular or Backbone, it's possible to attach your application to a React component. See <a href="https://github.com/davidchang/ngReact/issues/80">https://github.com/davidchang/ngReact/issues/80</a>.</p>
|
|
<h3 id="can-i-write-a-package-that-does-x-">Can I write a package that does X?</h3>
|
|
<p>If you don't find documentation for the part of N1 you want to extend, let us know! We're constantly working to enable new workflows by making more of the application extensible.</p>
|
|
<h3 id="can-i-distribute-my-package-">Can I distribute my package?</h3>
|
|
<p>Yes! We'll be sharing more information about publishing packages in the coming months. However, you can already publish and share packages by following the steps below:</p>
|
|
<ol>
|
|
<li><p>Create a Github repository for your package, and publish a <code>Tag</code> to the repository matching the version number in your <code>package.json</code> file. (Ex: <code>0.1.0</code>)</p>
|
|
</li>
|
|
<li><p>Make the CURL request below to the package manager server to register your package:</p>
|
|
<pre><code> curl -<span class="hljs-keyword">H</span> <span class="hljs-string">"Content-Type:application/json"</span> -X <span class="hljs-keyword">POST</span> -<span class="hljs-keyword">d</span> '{<span class="hljs-string">"repository"</span>:<span class="hljs-string">"https://github.com/<username>/<repo>"</span>}' https:<span class="hljs-comment">//edgehill-packages.nylas.com/api/packages</span>
|
|
</code></pre></li>
|
|
<li><p>Your package will now appear when users visit the N1 settings page and search for community packages.</p>
|
|
</li>
|
|
</ol>
|
|
<p>Note: In the near future, we'll be formalizing the process of distributing packages, and packages you publish now may need to be resubmitted.</p>
|