UNPKG

relay-cli

Version:

CLI for Relay.js

github.com/99xt/relay-cli

99xt/relay-cli

122 lines (75 loc) • 2.36 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# relay-cli CLI for Relay.js ## Install ``` npm install -g relay-cli ``` ## Quick start Quickest way to get started with relay-cli ``` $ relay init awesome-project $ cd awesome-project $ relay g component dashboard index $ relay v -c $ relay g container dashboard index $ relay v -d $ relay g route dashboard index $ relay v -r ``` ## Usage # Usage ### relay init [name] *alias: i* #### name Project name. --------------------------------------- ### relay generate component [module] [component] *alias: g* #### module Module name where the react component should be placed within. (Subdirectory within components directory) #### component React component name. --------------------------------------- ### relay generate container [module] [component] *alias: g* #### module Module name where the Relay container should be placed within. (Subdirectory within components directory) #### container Relay container name. --------------------------------------- ### relay generate route [module] [component] *alias: g* #### module Module name where the Relay route should be placed within. (Subdirectory within components directory) #### container Relay container name. --------------------------------------- ### relay generate route [module] [component] *alias: g* #### module Module name where the Relay route should be placed within. (Subdirectory within components directory) #### container Relay route name. --------------------------------------- ## Configuring existing projects To use realy-cli in existing React project navigate to directory where React components are created. Create realy-cli configuration file, `.relayclirc`. Add configuration in key value pairs. ``` { "client": "js" } ``` Example: This specifies that React components are placed in `js/components` directory. ## Contributor guidelines - Fork the repository. - Clone the forked repository. - Create your own branch. - Create tests and make sure tests pass on travis. - Create a pull request with changes made. ## Features - Generate Relay projects - Generate customizable React components - Create containers, routes - Configurable for existing Relay projects ## License MIT © [99XT](https://github.com/99xt)