You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/GETSTARTED.md
+20-27
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Getting started with Roc
2
2
3
-
This guide will walk you through how to set up your first project using React. This is just one example on how an application can be created. More guides and and documentation is on the way.
3
+
This guide will walk you through how to set up your first project using Roc. This is just one example on how an application can be created. More guides and and documentation is on the way.
4
4
5
5
## Install
6
6
Make sure you have [Node.js](https://nodejs.org) 4.x or higher and [npm](https://www.npmjs.com/) 3.x or higher on your system.
@@ -12,36 +12,12 @@ npm install -g roc
12
12
```
13
13
`roc` will now be available globally on your system.
14
14
15
-
## Create new Redux and React project
16
-
Create directory for your app:
17
-
```
18
-
mkdir react-app && cd react-app
19
-
```
15
+
## Create new Roc project
20
16
Bootstrap app starting point:
21
17
```
22
-
roc init web-react
23
-
```
24
-
### Tip
25
-
`web-react` is an alias to `vgno/roc-template-web-react`, a [repository location](https://github.com/vgno/roc-template-web-react) on Github. This template then uses the [roc-web-react](https://github.com/vgno/roc-web-react) extension. You can use your own repository by running `roc init GITHUB_USER/REPO`.
26
-
27
-
You _can_ create your own extensions but that is outside the scope of this guide.
28
-
29
-
## Development mode
30
-
```
31
-
roc dev
32
-
```
33
-
While this command is running the following is at your disposal:
34
-
- See your app running at http://localhost:3002 with Browsersync support.
35
-
- Manage your BrowserSync instance at http://localhost:3003. Connect as many different devices as you like.
36
-
- Live reloading is active, and code can be live-edited and will be live-pushed to your browser.
37
-
38
-
## View (dynamic) configuration options
39
-
```
40
-
roc dev --help
18
+
roc init my-first-roc-project
41
19
```
42
20
43
-
This prints all options that you can use to configure your current application. They are defined by the extensions that we use; currently `roc-web-react` in this guide. The runtime `cli` parameters are compatible with permanent values in `roc.config.js`.
44
-
45
21
## Default project structure
46
22
The basic template defines this for you, but you may modify it to use an entirely different structure easily through `roc.config.js`.
47
23
@@ -96,6 +72,23 @@ module.exports = {
96
72
};
97
73
```
98
74
75
+
76
+
## Development mode
77
+
```
78
+
roc dev
79
+
```
80
+
While this command is running the following is at your disposal:
81
+
- See your app running at http://localhost:3002 with Browsersync support.
82
+
- Manage your BrowserSync instance at http://localhost:3003. Connect as many different devices as you like.
83
+
- Live reloading is active, and code can be live-edited and will be live-pushed to your browser.
84
+
85
+
## View (dynamic) configuration options
86
+
```
87
+
roc dev --help
88
+
```
89
+
90
+
This prints all options that you can use to configure your current application. They are defined by the extensions that we use; currently `roc-web-react` in this guide. The runtime `cli` parameters are compatible with permanent values in `roc.config.js`.
91
+
99
92
## Change application configuration
100
93
Permanent configurations belonging to your application should be defined in `roc.config.js`.
0 commit comments