UNPKG

@financial-times/n-email-article/README.md

Version:

894 BMarkdownView Raw

1# FT Next's Email Article
2
3A component to share paywalled articles with others through email, whether they are FT subscribers or not.
4
5This is the client-side UI.
6
7## Demos
8
9[financial-times.github.io/n-email-article](http://financial-times.github.io/n-email-article)
10
11CircleCI doesn't push latest to GitHub Pages.  You will need to do it manually using your GitHub credentials:
12
13```sh
14sh gh-pages.sh
15```
16
17## Installation
18
19```sh
20git clone git@github.com:financial-times/n-email-article
21cd n-email-article
22make install
23```
24
25## Development
26
27To start a development web server with hot reloading capability:
28
29```sh
30make run
31```
32
33then open in the web browser:
34
35[https://local.ft.com:5050/webpack-dev-server/](https://local.ft.com:5050)
36
37## Usage
38
39See [demos](./demos) and search for `n-email-article` in [next-article](https://github.com/financial-times/next-article) for actual uses in production.

1	`# FT Next's Email Article`
2
3	`A component to share paywalled articles with others through email, whether they are FT subscribers or not.`
4
5	`This is the client-side UI.`
6
7	`## Demos`
8
9	`[financial-times.github.io/n-email-article](http://financial-times.github.io/n-email-article)`
10
11	`CircleCI doesn't push latest to GitHub Pages. You will need to do it manually using your GitHub credentials:`
12
13	```sh
14	`sh gh-pages.sh`
15	```
16
17	`## Installation`
18
19	```sh
20	`git clone git@github.com:financial-times/n-email-article`
21	`cd n-email-article`
22	`make install`
23	```
24
25	`## Development`
26
27	`To start a development web server with hot reloading capability:`
28
29	```sh
30	`make run`
31	```
32
33	`then open in the web browser:`
34
35	`[https://local.ft.com:5050/webpack-dev-server/](https://local.ft.com:5050)`
36
37	`## Usage`
38
39	See [demos](./demos) and search for `n-email-article` in [next-article](https://github.com/financial-times/next-article) for actual uses in production.