-
-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathindex.html
506 lines (336 loc) · 23.8 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
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" type="image/x-icon" href="/static/favicon.ico">
<link rel="stylesheet" href="/static/gen/style.css">
<link rel="stylesheet" href="/static/pygments.css">
<meta property="og:site_name" content="Creative Commons" />
<meta property="og:title" content="CC Browser Extension - A GSoC Project" />
<meta property="og:description" content="With the Creative Commons engineering team working very hard to catalog and index a plethora of CC-licensed works floating all over the internet, the next step is to make a suite of user-centric applications and interfaces to interact, consume and even reuse the content. The CC-Search is one such app with over 300 million CC-Licensed images indexed and since there is a full separation of concern between the backend (CC-Catalog-API) and frontend (CC-Catalog-frontend), we can leverage the backend architecture to design plugins for other platforms." />
<meta property="og:url" content="/blog/entries/cc-browser-extension-a-gsoc-project/" />
<meta property="og:type" content="article" />
<meta property="og:image" content="https://cc-og-image.vercel.app/CC Browser Extension - A GSoC Project.png?&md=1&fontFamily=roboto-condensed&fontSize=100px&images=https%3A%2F%2Fcc-vocabulary.netlify.app%2Flogos%2Fproducts%2Fopen_source.svg%23opensource" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="CC Browser Extension - A GSoC Project">
<meta name="twitter:description" content="With the Creative Commons engineering team working very hard to catalog and index a plethora of CC-licensed works floating all over the internet, the next step is to make a suite of user-centric applications and interfaces to interact, consume and even reuse the content. The CC-Search is one such app with over 300 million CC-Licensed images indexed and since there is a full separation of concern between the backend (CC-Catalog-API) and frontend (CC-Catalog-frontend), we can leverage the backend architecture to design plugins for other platforms.">
<meta name="twitter:site" content="@creativecommons">
<meta name="twitter:creator" content="@creativecommons">
<script src="https://code.jquery.com/jquery-3.3.1.min.js"
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k" crossorigin="anonymous"></script>
<script type="text/javascript" src="/static/gen/script.js"></script>
<script src="https://unpkg.com/@creativecommons/vocabulary@2020.7.2/js/vocabulary.js"></script>
<script>
const globalHeaderInstance = vocabulary.createGlobalHeader();
</script>
<title>CC Browser Extension - A GSoC Project — Creative Commons Open Source</title>
<body>
<!-- Header -->
<header class="container">
<nav class="navbar">
<div class="navbar-brand">
<a class="has-text-black" href="/" aria-label="Home">
<svg
class="logo margin-top-small"
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 284 46">
<use href="#opensource"></use>
</svg>
</a>
<a role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
</div>
<div class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item is-active" href="/blog/entries/">
Blog
</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Contribute<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/contributing-code/">Contribution Guidelines</a>
<a class="navbar-item" href="/contributing-code/projects/">Project List</a>
<a class="navbar-item" href="/contributing-code/issue-finder/">Issue Finder</a>
<a class="navbar-item" href="/contributing-code/pr-guidelines/">Pull Request Guidelines</a>
<a class="navbar-item" href="/contributing-code/github-repo-guidelines/">GitHub Repo Guidelines</a>
<a class="navbar-item" href="/contributing-code/repo-labels/">Repository Labels</a>
<a class="navbar-item" href="/contributing-code/foundational-tech/">Foundational technologies</a>
<a class="navbar-item" href="/contributing-code/documentation-guidelines/">Documentation Guidelines</a>
<a class="navbar-item" href="/contributing-code/javascript-guidelines/">JavaScript Guidelines</a>
<a class="navbar-item" href="/contributing-code/python-guidelines/">Python Guidelines</a>
<a class="navbar-item" href="/contributing-code/translation-guide/">Translation Guide</a>
<a class="navbar-item" href="/contributing-code/usability/">Usability</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Community<i class="icon caret-down"></i></a>
<div class="navbar-dropdown is-active">
<a class="navbar-item" href="/community/">Join the Community</a>
<a class="navbar-item" href="/community/community-team/">Community Team</a>
<a class="navbar-item" href="/community/community-team/members/">Community Team Members</a>
<a class="navbar-item" href="/community/community-team/project-roles/">Project Roles</a>
<a class="navbar-item" href="/community/community-team/community-building-roles/">Community Building Roles</a>
<a class="navbar-item" href="/community/write-a-blog-post/">Write a Blog Post</a>
<a class="navbar-item" href="/community/code-of-conduct/">Code of Conduct</a>
<a class="navbar-item" href="/community/code-of-conduct/enforcement/">Code of Conduct Enforcement</a>
<a class="navbar-item" href="/community/supporters/">Supporters</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link is-arrowless " tabindex="0">
Work Programs<i class="icon caret-down"></i></a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/programs/">Overview</a>
<a class="navbar-item" href="/programs/project-ideas/">Project Ideas</a>
<a class="navbar-item" href="/programs/applicant-guide/">Applicant Guide</a>
<a class="navbar-item" href="/programs/contrib-guide/">Contributor Guide</a>
<a class="navbar-item" href="/programs/lead-guide/">Project Lead Guide</a>
<a class="navbar-item" href="/programs/history/">History</a>
</div>
</div>
</div>
</div>
</nav>
</header>
<!-- Breadcrumb -->
<div class="breadcrumb-container">
<nav class="container breadcrumb caption bold" aria-label="breadcrumbs">
<ul>
<!-- Extracting the slugs of URL -->
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/">
Home
</a></li>
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/blog/">
Blog
</a></li>
<!-- Active link -->
<!-- Forming the URL using extracted slugs -->
<li><a class="link" href="/blog/entries/">
Entries
</a></li>
<!-- Active link -->
<li class="is-active"><a aria-current="page displayed">CC Browser Extension - A GSoC Project</a></li>
</ul>
</nav>
</div>
<!-- Body -->
<div class="single-post">
<header class="single-post-header">
<div class="container">
<h4>CC Open Source Blog</h4>
<h2 class="title">CC Browser Extension - A GSoC Project</h2>
<div class="author columns is-marginless">
<header>
<figure class="image blog-image">
<img class="profile" src="https://secure.gravatar.com/avatar/295aeb4b22aac290b7a5c29fdeb31107?size=200&d=mp" alt="author's gravatar" />
</figure>
</header>
<p class="padding-small">
by <a class="author-name" href="/blog/authors/makkoncept/">Mayank Nader</a> on 2019-06-20
</p>
</div>
<div class="series-header">
<span>This blog is part of the series:</span>
<a href="#series">GSoC 2019: CC Search Browser Extension</a>
</div>
</div>
</header>
<div class="single-post-body content container">
<p>With the Creative Commons engineering team working very hard to catalog and index a plethora of CC-licensed works floating all over the internet, the next step is to make a suite of user-centric applications and interfaces to interact, consume and even reuse the content. The CC-Search is one such app with over <a href="/blog/entries/cc-search-out-of-beta/">300 million CC-Licensed images indexed</a> and since there is a full separation of concern between the backend (<a href="https://github.com/cc-archive/cccatalog-api">CC-Catalog-API</a>) and frontend (<a href="https://github.com/cc-archive/cccatalog-frontend">CC-Catalog-frontend</a>), we can leverage the backend architecture to design plugins for other platforms.</p>
<p>This GSoC project aims to do this by making a Cross-Browser extension to interact with CC-Catalog-API.</p>
<h3 id="why-browser-extension">Why browser Extension?</h3><ul>
<li>Having at least two browser-centric front-ends (<a href="https://search.creativecommons.org/">CC Search web app</a> and browser extension) to the CC-Catalog-API would be beneficial because based on the community feedback we can ship only those features to the extension that would make the most sense to its users while having CC Search up to date. Therefore making <em>two flavors of interfaces</em> in the process.</li>
<li>We don’t have to tackle compatibility issues of different Operating Systems. If it runs in Firefox, it will run on any OS that has Firefox.</li>
<li>Majority of users surf the internet through modern browsers which provide easy ways to add extensions with most of them having dedicated online stores.</li>
<li>Most people tend to look for an extension for something they do more often on the internet so that they can save time, so it makes sense to develop one for CC Search also.</li>
<li>Personalized experience: I talk more about this later in the post.</li>
</ul>
<h3 id="the-plan">The Plan:</h3><p>The first task would be to make an MVP that would be inspired by the CC Search design. For this, I will make sure to have the least dependence on browser extension APIs (probably use only <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserAction">browserAction</a>) so that the extension can be easily ported to different browsers without any major change in the code. Sure, we still have to work out porting and polyfilling CS3 and javaScript code to work on different browsers, but having one less thing to worry about while porting the initial version of extension will only help.</p>
<p>Then I want to move to the next step and work on things that would make the user experience more personal and intuitive and here various browser extensions APIs would come handy, like <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage">storage</a>, <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs">tabs</a>, etc. Then the priority would shift to making the extension compatible with Firefox and chrome.</p>
<h3 id="what-do-i-mean-by-personalized-experience">What do I mean by Personalized experience?</h3><p>Most people who will download the extension would want it to act as their own. They would want to customize it so that their flow is more intuitive and they don't have to repeat steps like if one user searches extensively for CC Content on Behance and DeviantArt only, they would want to not set the search filter before every new session. <em>This is where the browser extension shines</em>.</p>
<p>One good example of solving this problem would be to make an options page, that would open in a new tab, where they can set the filters they use more often as default.</p>
<p>Similarly, if we add a feature, say dark-mode, then the users who prefer it over the default can set their preferences.</p>
<h3 id="work-done-till-now">Work Done till Now:</h3><p><div>
<img src="extension-screenshot.png" alt"CC Browser Extension Screenshot" align="middle"/><br>
<small class="muted" style="display:block; text-align:center;">CC Browser Extension Screenshot</small>
</div>
<br></p>
<ul>
<li>Set up the project directory structure, Eslint, Circle-ci.</li>
<li>Set up the popup markup and styles.</li>
<li>Started making API calls. You can search and get thumbnails of images.</li>
<li>Showing image metadata like its title, license, provider when thumbnails are hovered on.</li>
<li>Add a loading animation.</li>
<li>Add functionality to apply license and provider filters to search.</li>
</ul>
<h3 id="coming-up">Coming up</h3><ul>
<li>Set up lazy loading or pagination.</li>
<li>Start working on the functionality of showing the image preview with data, attribution, etc when we click on the image. This may take more than one week.</li>
</ul>
<h3 id="how-you-can-help">How you can help</h3><p>The development is still in the initial phase but you can check out <strong>a working extension</strong> at the <a href="https://github.com/creativecommons/ccsearch-browser-extension">Github Repository</a>. There are instructions to help you get started and load it to Firefox.</p>
<p>Tell us what you expect the extension to do, or a feature that you wish would be implemented. At this early stage of development, it might help us improve our goals. You can join the discussion on <code>#gsoc-browser-ext</code> channel on <a href="/community/#slack">slack</a>.</p>
<p>I would like to thank <a href="https://creativecommons.org/author/aldencreativecommons-org/">Alden</a>, <a href="https://creativecommons.org/author/timidcreativecommons-org/">Timid</a> and <a href="https://creativecommons.org/author/kriticreativecommons-org/">Kriti</a> to for their mentorship and providing an experienced perspective and solutions to the problems faced by this naive developer.</p>
</div>
<footer class="single-post-footer container">
<div class="category">
<h4 class="category-title">Categories</h4>
<div class="categories">
<a class="button tag" href=" /blog/categories/gsoc/ ">gsoc</a>
<a class="button tag" href=" /blog/categories/gsoc-2019/ ">gsoc-2019</a>
<a class="button tag" href=" /blog/categories/cc-browser-extension/ ">cc-browser-extension</a>
<a class="button tag" href=" /blog/categories/cc-search/ ">cc-search</a>
<a class="button tag" href=" /blog/categories/cc-catalog/ ">cc-catalog</a>
<a class="button tag" href=" /blog/categories/open-source/ ">open-source</a>
</div>
</div>
<div class="series-posts" id="series">
<h5 class="title">Posts in the GSoC 2019: CC Search Browser Extension series</h5>
<ul class="posts">
<li class="has-color-dark-slate-gray">
<i class="icon circle-filled"></i>CC Browser Extension - A GSoC Project
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/cc-browser-extension-week5-6/">CC Browser Extension Week 5, 6</a>
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/cc-browser-extension-week7-8/">CC Browser Extension Week 7, 8</a>
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/cc-browser-extension-week9-10/">CC Browser Extension Week 9, 10</a>
</li>
<li>
<i class="icon circle-filled"></i><a href="/blog/entries/introducing-cc-search-extension/">Introducing CC Search Extension</a>
</li>
</ul>
</div>
<div class="comments">
<div id="disqus_thread"></div>
<script>
var disqus_config = function() { this.page.identifier = "/blog/entries/cc-browser-extension-a-gsoc-project"; this.page.url = "http://opensource.creativecommons.org/blog/entries/cc-browser-extension-a-gsoc-project/"; };
(function() {
var d = document, s = d.createElement('script');
s.src = '//cc-open-source.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>
Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
rel="nofollow">comments powered by Disqus.</a>
</noscript>
</div>
</footer>
</div>
<!-- Footer -->
<footer class="main-footer">
<div class="container">
<div class="columns">
<div class="column is-one-third-tablet-only is-one-quarter-desktop">
<a href="https://creativecommons.org" class="main-logo margin-bottom-bigger">
<span class="has-text-white">
<svg
xmlns="http://www.w3.org/2000/svg"
preserveAspectRatio="xMidYMid meet"
viewBox="0 0 304 73">
<use href="#logomark"></use>
</svg>
</span>
</a>
<div>
<address class="margin-bottom-normal">Creative Commons<br />PO Box 1866, Mountain View CA 94042</address>
<a href="mailto:info@creativecommons.org" class="mail">info@creativecommons.org</a><br />
<a href="tel://+1-415-429-6753" class="phone">+1-415-429-6753</a>
</div>
<div class="margin-vertical-large">
<a href="https://www.instagram.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">instagram</i>
</a>
<a href="https://www.facebook.com/creativecommons" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">facebook</i>
</a>
<a href="https://www.linkedin.com/company/creative-commons/" class="social has-text-white" target="_blank"
rel="noopener">
<i class="icon margin-right-small is-size-4">linkedin</i>
</a>
</div>
</div>
<div class="column is-two-third-tablet-only is-three-quarters-desktop">
<div class="columns">
<div class="column is-full">
<nav class="footer-navigation">
<ul class="menu">
<li>
<a href="/blog/entries/" class="menu-item">Blog</a>
</li>
<li>
<a href="/community/community-team/" class="menu-item">Community Team</a>
</li>
<li>
<a href="/contributing-code/projects/" class="menu-item">Project List</a>
</li>
<li>
<a href="/archives/" class="menu-item">Archives</a>
</li>
</ul>
</nav>
</div>
</div>
<div class="columns">
<div class="column is-two-thirds">
<div class="subscription">
<h5 class="b-header">Subscribe to our newsletter</h5>
<form class="newsletter">
<input type="email" id="emailInput" class="input" placeholder="Your email" required>
<input type="submit" value="subscribe" class="button small">
</form>
</div>
<div class="attribution margin-top-bigger">
<p class="caption">
Except where otherwise
<a href="https://creativecommons.org/policies#license" target="_blank" rel="noopener">noted</a>,
content on this site is licensed under a
<a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noopener">Creative Commons
Attribution 4.0 International license</a>.
<a href="https://creativecommons.org/website-icons" target="_blank" rel="noopener">Icons</a>
by
<a href="https://fontawesome.com/" target="_blank" rel="noopener">Font Awesome</a>.
</p>
<div class="margin-top-smaller">
<i class="icon margin-right-small is-size-4">cclogo</i>
<i class="icon margin-right-small is-size-4">ccby</i>
</div>
</div>
</div>
<div class="column is-one-third">
<aside class="donate-section">
<h5>Our work relies on you!</h5>
<p>Help us keep the internet free and open.</p>
<a class="button small donate" href="https://creativecommons.org/donate?c_src=website&c_src2=GlobalFooter">
<i class="icon cc-letterheart-filled margin-right-small is-size-5 padding-top-smaller"></i>
Donate now
</a>
</aside>
</div>
</div>
</div>
</div>
</div>
</footer>
</body>
</html>