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: README.md
+14-1
Original file line number
Diff line number
Diff line change
@@ -7,4 +7,17 @@ Coming soon.
7
7
8
8
## Setup
9
9
10
-
Coming soon.
10
+
Setting up Cement on your local machine is easy. There's two folders to look out for. The `lib` folder contains the framework code that compliles into `dist`. The `dist` folder is what you would use in your node_modules folder.
11
+
12
+
The `debug` folder is its own project running within Cement to test the framework. Here's a quick guide on how to set it up.
13
+
14
+
1. First of all we need all our dependencies installed.
15
+
Run `npm install` in both the root directory and in the `debug` folder.
16
+
17
+
2. To compile our `lib` folder into `dist` with our config file we have to run `rollup -c` in the root directory.
18
+
19
+
3. Now let's create a node_module link for Cement. Go to the root folder and run `npm link`, then head to the `dist` folder and run `npm link cement`. This creates a cement folder in your node_modules folder.
20
+
21
+
4. Lastly go to your `debug` folder and run this command to start the test project `npm start`
22
+
23
+
Woila! Project should now be running on `http://localhost:8080/`.
0 commit comments