-
Notifications
You must be signed in to change notification settings - Fork 3
/
docs.html
172 lines (131 loc) · 9.13 KB
/
docs.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<link href='https://fonts.googleapis.com/css?family=Chivo:900' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>Photo Project by photo</title>
</head>
<body>
<div id="container">
<div class="inner">
<header>
<h1><a href="index.html">Photo Project</a></h1>
<h2></h2>
</header>
<ul id="nav">
<li><a href="docs.html">Documentation</a></li>
<li><a href="https://github.com/photo/frontend">Download</a></li>
<li><a href="https://github.com/photo/mobile-android">Android App</a></li>
<li><a href="https://github.com/photo/mobile-ios">iPhone App</a></li>
<li><a href="https://github.com/photo/documentation/tree/master/docs/contribute">Contribute</a></li>
</ul>
<hr>
<section id="main_content">
<h2>Documentation</h3>
<p>Welcome to the Photo Project's documentation. Here you'll find guides to installing the software yourself as well as guides to our API and libraries.</p>
<h3>Installation Guides</h3>
<p>We offer a set of installation guides to help you get your site up and running. Choose a guide and get started:</p>
<ul>
<li><a href="https://github.com/photo/documentation/blob/master/docs/guides/InstallationUbuntuApache.markdown">Ubuntu and Apache</a></li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/guides/InstallationFedora16Apache.markdown">Fedora and Apache</a></li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/guides/InstallationOSXMacports.markdown">OSX and Macports</a></li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/guides/InstallationSUSE.markdown">SUSE and Apache</a></li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/guides/InstallationDreamhost.markdown">Dreamhost Guide</a></li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/guides/InstallationUsingOpenPhotoEC2-AMI.markdown">AWS EC2 with an AMI</a></li>
</ul>
<p>Check <a href="https://github.com/photo/documentation/tree/master/docs/guides">the guides area of the documentation</a> if you don't see your setup; it may be there.</p>
<p>You can also run <a href="https://raw.github.com/photo/frontend/master/documentation/guides/InstallationUbuntuApache.sh">this script</a>:</p>
<pre>curl https://raw.github.com/photo/frontend/master/documentation/guides/InstallationUbuntuApache.sh | /bin/bash</pre>
<p>(Make sure to view any script before you run it!)</p>
<h3>API Endpoints</h3>
<p>The Photo Project's REST API lets you extend your site and build things on top of it. Let us know if you build something neat with the API; we'd love to see it.</p>
<p>The first thing you should do is <a href="https://github.com/photo/documentation/blob/master/docs/api/Authentication.markdown">authenticate with the API</a>. You might also want to grab a language library:</p>
<ul>
<li><a href="https://github.com/photo/openphoto-php">Our PHP language binding</a></li>
<li><a href="https://github.com/photo/openphoto-ruby">Our Ruby language binding</a></li>
<li><a href="https://github.com/photo/openphoto-python">Our Python language binding</a></li>
<li><a href="https://github.com/photo/openphoto-java">Our Java language binding</a></li>
<li><a href="https://github.com/photo/openphoto-javascript">Our Javascript language binding</a></li>
<li><a href="https://github.com/photo/openphoto-objective-c">Our Objective-C language binding</a></li>
</ul>
<h4>Test/Diagnostic Endpoints</h4>
<ul>
<li><a href="https://github.com/photo/documentation/blob/master/docs/api/GetHelloWorld.markdown">GET /hello.json</a> Test endpoint.</li>
</ul>
<h4>Action Endpoints (comments, favorites, etc)</h4>
<ul>
<li><a href="https://github.com/photo/documentation/blob/master/docs/api/PostActionCreate.markdown">POST /action/:id/:type/create.json</a> Create an action.</li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/api/PostActionDelete.markdown">POST /action/:id/delete.json</a> Delete an action.</li>
</ul>
<h4>Photo Endpoints</h4>
<ul>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostPhotoDelete.markdown">POST /photos/:id/delete.json</a> Delete a user's photo.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostPhotoUpdate.markdown">POST /photos/:id/update.json</a> Update data on a user's photo.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetPhoto.markdown">GET /photo/:id/view.json</a> Get a user's photo.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetPhotos.markdown">GET /photos/list.json</a> Get a list of the user's photos.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetPhotoNextPrevious.markdown">GET /photo/:id/nextprevious.json</a> Get the next and previous photo.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostPhotoUpload.markdown">POST /photo/upload.json</a> Upload a new photo.</li>
</ul>
<h4>Tag Endpoints</h4>
<ul>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetTags.markdown">GET /tags/list.json</a> Get a user's tags.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostTagCreate.markdown">POST /tag/create.json</a> Create a tag for the user.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostTagUpdate.markdown">POST /tag/:id/update.json</a> Modify meta data for a user's tag.</li>
</ul>
<h4>Group Endpoints</h4>
<ul>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetGroup.markdown">GET /group/:id/view.json</a> Get a group.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetGroups.markdown">GET /groups/list.json</a> Get a listing of a user's groups.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostGroupCreate.markdown">POST /group/create.json</a> Create a group.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostGroupDelete.markdown">POST /group/delete.json</a> Delete a group.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostGroupUpdate.markdown">POST /group/update.json</a> Update a group.</li>
</ul>
<h4>Webhook Endpoints</h4>
<ul>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostWebhookSubscribe.markdown">POST /webhook/subscribe</a> Create or subscribe to an existing webhook.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/GetWebhook.markdown">GET /webhook/:id/view.json</a> Get a user's webhook by id.</li>
<li> <a href="https://github.com/photo/documentation/blob/master/docs/api/PostWebhookDelete.markdown">POST /webhook/:id/delete.json</a> Delete an existing webhook.</li>
</ul>
<h3>API FAQs</h3>
<ul>
<li><a href="https://github.com/photo/documentation/blob/master/docs/faq/PhotoGeneration.markdown">How photos are generated</a></li>
<li><a href="https://github.com/photo/documentation/blob/master/docs/faq/ReturnSizes.markdown">How to get specific photo sizes</a></li>
</ul>
<h3>Contribution Guides</h3>
<p>We welcome contributions to the documentation as well as to the core codebase. All of our documentation is hosted in the documentation repository at Github.</p>
<p>If you'd like to contribute we have a couple of guides to help you get started.</p>
<ul>
<li><a href="https://github.com/photo/documentation/blob/master/docs/contribute/frontend.markdown">How to contribute code</a> and make the Photo Project better</li>
<li><a href-"https://github.com/photo/documentation/blob/master/docs/contribute/documentation.markdown">How to contribute documentation</a></li>
</ul>
<h3>Contact</h3>
<p>Questions? There are a couple of ways to get in touch.</p>
<ul>
<li>Email our mailing list at <a href="mailto:[email protected]">[email protected]</a>.</li>
<li>Ask in our IRC channel. We're at #openphoto on Freenode.</li>
</ul>
</section>
<footer>
This page was generated by <a href="http://pages.github.com">GitHub Pages</a>. Tactile theme by <a href="http://twitter.com/jasonlong">Jason Long</a>.
</footer>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-29785237-5");
pageTracker._trackPageview();
} catch(err) {}
</script>
</div>
</div>
</body>
</html>