Skip to content

Commit 7bc6f1a

Browse files
committed
add documentation
1 parent 20df2fc commit 7bc6f1a

37 files changed

+15450
-0
lines changed

doc/script-apex/.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.deploy
2+
.publish
3+
.temp
4+
dist
5+
node_modules
6+
temp

doc/script-apex/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# R.apex
2+
3+
[![Built with Electric](https://img.shields.io/badge/built%20with-electric-f3c302.svg?style=flat)](http://electricjs.com)
4+
5+
## Setup
6+
7+
1. Make sure you have [node and npm](https://nodejs.org/en/download/) installed:
8+
9+
```sh
10+
node -v && npm -v
11+
```
12+
13+
2. Install our global dependencies:
14+
15+
```sh
16+
[sudo] npm i -g electric-cli
17+
```
18+
19+
3. Install our local dependencies:
20+
21+
```sh
22+
npm i
23+
```
24+
25+
## Usage
26+
27+
* Build the site, serve it locally, and watch for any changes:
28+
29+
```
30+
electric run
31+
```
32+
33+
* Deploy to production (send build files to `wedeploy` branch):
34+
35+
```
36+
electric deploy
37+
```

doc/script-apex/electric.config.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
'use strict';
2+
3+
var marble = require('marble');
4+
5+
module.exports = {
6+
basePath: '/script-apex',
7+
metalComponents: ['electric-marble-components', 'marble-topbar'],
8+
sassOptions: {
9+
includePaths: ['node_modules', marble.src]
10+
},
11+
vendorSrc: ['node_modules/marble/build/fonts/**']
12+
};

0 commit comments

Comments
 (0)