forked from BuildFire/sdk
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
76 lines (74 loc) · 2.56 KB
/
index.html
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
<!DOCTYPE html>
<html lang="en" ng-app="home">
<head>
<!-- Title & Favicons -->
<title>BuildFire SDK</title>
<link rel="icon" type="image/png" href="/images/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/png" href="/images/favicon-32x32.png" sizes="32x32">
<!-- CSS -->
<link href="styles/helper.css" rel="stylesheet"/>
<link href="styles/bootstrap.css" rel="stylesheet"/>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<style type="text/css" media="screen">
body{
background:#eef0f0;
font-size:14px;
line-height:22px;
}
.main{
background:#fff;
width:100%;
max-width:1000px;
margin:60px auto;
padding:20px;
}
ul{
margin:0;
padding:0;
}
ul li{
list-style:none;
margin:15px 0;
}
</style>
<body>
<div class="main border-grey border-radius-four">
<div class="intro">
<h2 class="margin-top-zero">BuildFire Plugins SDK</h2>
<p>Here you will find the help you need to start building your plugin.</p>
</div>
<hr>
<div>
<h3>Getting Started</h3>
<ul class="margin-top-fifteen">
<li>1. To get started, sign up for the developer program at <a href="http://dev.buildfire.com" class="text-primary" target="_blank">http://dev.buildfire.com</a>.</li>
<li>2. Once you have done so, you should be issued an App ID that can be used test your plugin.</li>
<li>3. Open scripts/appContext.js and change the appId in window.appContext.currentApp.</li>
<li>4. Now you can begin developing your plugin in plugins/myPlugin.</li>
<hr class="none">
<li class="text-danger">If you choose to change the folder name, make sure to change it in the scripts/appContext.js file as well.</li>
<li class="text-danger">Make sure you run your local environment as a web application environment and not as static files from the file system.</li>
</ul>
<hr class="none">
<a class="btn btn-primary" href="https://github.com/BuildFire/pluginTemplate/wiki">Learn More</a>
</div>
<hr>
<div>
<h3>Examples</h3>
<ul class="margin-top-fifteen">
<li><a href="pluginTester/#plugin/examplePlugin" class="text-primary">examplePlugin - Illustrates how to save and retrieve simple data structures.</a></li>
</ul>
</div>
<hr>
<div>
<h3>Testing Locally</h3>
<p>Once you have developed your plugin, click below to test it locally.</p>
<a class="btn btn-primary" href="pluginTester/">Test Plugin</a>
</div>
</div>
</body>
</html>