Skip to content
Newer
Older
100644 131 lines (91 sloc) 4.09 KB
35f8975 @mixedpuppy add build instructions
mixedpuppy authored Aug 29, 2011
1
2 PreRequisite
3 ===============
4
5 * Firefox
6 * Python
7 * Git
8 * make
9
10 Getting setup
11 =====================
12
13 To pull and run openwebapps addon:
14
15 git clone https://github.com/mozilla/openwebapps
16 cd openwebapps
17 make pull
18 make run
19
20 You can build an xpi:
21
22 make xpi
23
24 You can run the tests:
25
26 make test
27
28
29 If you want to run (using make run) in a specific profile:
30
31 OWA_PROFILE=/path/to/firefox/profile make run
32
33 Tests cannot be run in a specific profile.
34
35
36 Prepare your firefox profile
37 -----------------------------
38
39 You probably want a test firefox profile so open up the [Profile Manager](http://kb.mozillazine.org/Profile_manager).
40
41 In the Mac:
42
43 /Applications/Firefox.app/Contents/MacOS/firefox -ProfileManager
44
45 On Windows:
46
47 firefox.exe -P
48
49 In the profile manager, create a profile with the name `fxsharetest`, then exit the profile manager.
50
51 Repository Layout
52 ===================
53
46b4868 markdownify README
Lloyd Hilaiel authored Sep 14, 2010
54 This is an experiment around installable web applications. What
55 you'll find here:
56
57 <dl>
58 <dt>addons/</dt>
59 <dd>Addons for different browsers that provide better support
60 for web applications: including new features (like search and
61 notification support) and better integration into browser UI.</dd>
62
098d31b Added missing directories to README.md.
Michael Hanson authored Oct 19, 2010
63 <dl>
64 <dt>docs/</dt>
65 <dd>Documentation, including an in-depth discussion of the design
66 and goals of the project.</dd>
67
46b4868 markdownify README
Lloyd Hilaiel authored Sep 14, 2010
68 <dt>example/</dt>
69 <dd>An example that shows how to integrate myapps javascript libraries
70 to allow a site author to trigger an installation of their application.</dd>
71
72 <dt>harness/</dt>
73 <dd>Files related to setting up a local develoment environment. Currently
74 a nodejs script that will allow you to run a webserver that serves
75 up the various sites contained here.</dd>
76
77 <dt>site/</dt>
78 <dd>The "myapps" website. To the end user this site is a location
79 where they can launch their application dashboard. To the developer
80 this is the domain under which several javascript libraries are
81 hosted that allow interaction with the user's applications.
82 Site nightlies are hosted at https://myapps.mozillalabs.com</dd>
83 </dl>
098d31b Added missing directories to README.md.
Michael Hanson authored Oct 19, 2010
84
85 <dt>store/</dt>
86 <dd>The "appstore" website, implemented as a Python webserver.
87 Implements a demonstration application store that performs
88 authentication of users and provides "proof-of-purchase" assertions
89 to applications. No real payment processing is performed.
90 Hosted at https://appstore.mozillalabs.com.
91 </dd>
92 </dl>
6e99910 @lloyd include traditional tri-licensing
lloyd authored Oct 19, 2010
93
94 ## LICENSE
95
96 All files that are a part of this project, except where explicitly noted, are covered
97 by The following license:
98
99 Version: MPL 1.1/GPL 2.0/LGPL 2.1
100
101 The contents of this file are subject to the Mozilla Public License Version
102 1.1 (the "License"); you may not use this file except in compliance with
103 the License. You may obtain a copy of the License at
104 http://www.mozilla.org/MPL/
105
106 Software distributed under the License is distributed on an "AS IS" basis,
107 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
108 for the specific language governing rights and limitations under the
109 License.
110
111 The Original Code is openwebapps.
112
113 The Initial Developer of the Original Code is Mozilla Foundation.
114
115 Portions created by the Initial Developer are Copyright (C) 2010
116 the Initial Developer. All Rights Reserved.
117
118 Contributor(s):
119
120 Alternatively, the contents of this file may be used under the terms of
121 either the GNU General Public License Version 2 or later (the "GPL"), or
122 the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
123 in which case the provisions of the GPL or the LGPL are applicable instead
124 of those above. If you wish to allow use of your version of this file only
125 under the terms of either the GPL or the LGPL, and not to allow others to
126 use your version of this file under the terms of the MPL, indicate your
127 decision by deleting the provisions above and replace them with the notice
128 and other provisions required by the GPL or the LGPL. If you do not delete
129 the provisions above, a recipient may use your version of this file under
130 the terms of any one of the MPL, the GPL or the LGPL.
Something went wrong with that request. Please try again.