1 | # @shopify/slate-env
|
2 |
|
3 | Manages the environment variables which are needed by Slate to interact with Shopify servers. Can create and run `.env` files used to store Slate environment variables for development.
|
4 |
|
5 | By default, Slate will look for a `.env` file with environment variables.
|
6 |
|
7 | Alternatively, users can specify `--env` with slate-tools scripts to use associated `.env.{env}` file. For example:
|
8 |
|
9 | ```
|
10 | $ slate-tools start --env=production
|
11 | ```
|
12 |
|
13 | will look for a `.env.production` file.
|
14 |
|
15 | ## Default .env file format
|
16 |
|
17 | ```bash
|
18 | # The myshopify.com URL to your Shopify store
|
19 | SLATE_STORE=
|
20 |
|
21 | # The API password generated from a Private App
|
22 | SLATE_PASSWORD=
|
23 |
|
24 | # The ID of the theme you wish to upload files to
|
25 | SLATE_THEME_ID=
|
26 |
|
27 | # A list of file patterns to ignore, with each list item separated by ':'
|
28 | SLATE_IGNORE_FILES=
|
29 | ```
|
30 |
|
31 | # Store / Environment Configuration Tips
|
32 |
|
33 | Knowing what to put in your `.env` isn't always straightforward. This guide aims to clarify what data is needed, and where to get it.
|
34 |
|
35 | _Note: [ThemeKit](http://shopify.github.io/themekit/) is the tool that powers Slate deploys. See it's
|
36 | [configuration variables documentation](http://shopify.github.io/themekit/configuration/) for more details._
|
37 |
|
38 | ### Finding your SLATE_THEME_ID
|
39 |
|
40 | \_**warning:** some commands ([`start`](https://github.com/Shopify/slate-cli#start), [`deploy`](https://github.com/Shopify/slate-cli#deploy)) will overwrite the existing code on this `SLATE_THEME_ID` with your local project's content.
|
41 | To avoid losing work, we suggest you go to [/admin/themes](//www.shopify.com/admin/themes) and duplicate
|
42 | an existing theme to work from.
|
43 |
|
44 | Go to your store's [/admin/themes.xml](//www.shopify.com/admin/themes.xml),
|
45 | and copy the `id` for the theme you would like to update:
|
46 |
|
47 | ![https://screenshot.click/17-02-w0fw2-zczky.png](https://screenshot.click/17-02-w0fw2-zczky.png)
|
48 |
|
49 | ![https://screenshot.click/17-04-mng8o-k9da8.png](https://screenshot.click/17-04-mng8o-k9da8.png)
|
50 |
|
51 | _alternatively, you can set the `SLATE_THEME_ID` to **"live"** to update the published theme_
|
52 |
|
53 | ### Generating your SLATE_PASSWORD
|
54 |
|
55 | Navigate to your store's private apps page ([/admin/apps/private](//www.shopify.com/admin/apps/private)).
|
56 |
|
57 | ![https://screenshot.click/17-06-j9e9m-n2jxa.png](https://screenshot.click/17-06-j9e9m-n2jxa.png)
|
58 |
|
59 | Create a new private app and copy the password:
|
60 |
|
61 | ![https://screenshot.click/17-07-u19kf-rx53b.png](https://screenshot.click/17-07-u19kf-rx53b.png)
|
62 |
|
63 | Assign the private app permissions to "Read and Write" for theme templates and theme assets:
|
64 |
|
65 | ![https://screenshot.click/17-09-owv1p-5lugl.png](https://screenshot.click/17-09-owv1p-5lugl.png)
|