aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--news/2018-08.html.j240
-rw-r--r--template/gsoc-2018-gnunet-webui.html.j274
-rw-r--r--www.yml5
3 files changed, 37 insertions, 82 deletions
diff --git a/news/2018-08.html.j2 b/news/2018-08.html.j2
deleted file mode 100644
index 3555c0fa..00000000
--- a/news/2018-08.html.j2
+++ /dev/null
@@ -1,40 +0,0 @@
1{% extends "common/news.j2" %}
2{% block body_content %}
3 <h1>GSoC 2018 - GNUnet Web-based User Interface</h1>
4<p>
5 Tue, 08/14/2018 - 07:55 - Phil Buschmann
6</p>
7<h4>What was done?</h4>
8<p>
9 In the context of Google Summer of Code 2018, my mentor (Martin Schanzenbach) and I have worked on creating and extending the REST API of GNUnet. Currently, we mirrored the functionality of following commands:
10</p>
11<ul>
12 <li>gnunet-identity
13 <li>gnunet-namestore
14 <li>gnunet-gns
15 <li>gnunet-peerinfo
16</ul>
17<p>
18 Additionally, we developed a website with the Javascript framework Angular 6 and the design framework iotaCSS to use the new REST API. The REST API of GNUnet is now documented with Sphinx.
19</p>
20<h4>Why did we create a REST API?</h4>
21<p>
22 ... when you can use the command line tools? We need to keep in mind, that everyone has the right to stay secure and private but not everyone feels comfortable using a terminal. The further developed REST access to GNUnet APIs in addition to the new web application allows new users to interact with GNUnet over a well known tool: their browsers. This addition to the C API and the command line tools may attract new users and developers.
23</p>
24<h4>How can we use it?</h4>
25<ol>
26 <li>The REST API developed in GNUnet<br>The REST API is already merged into the gnunet.git repository (GNUnet Main Git). To use the new features, clone the repository and follow the Installation on gnunet.org. Then, start the rest service with "gnunet-arm -i rest".</li>
27 <li>The Web Application<br>The web application is available under the gnunet-webui.git repository (GNUnet WebUI Git). You need to install the newest version of 'node' and 'yarn'. Dependent on your system, you may need to download newer versions and install them manually and not over your packet manager. After the installation succeeded, you need to clone the repository. Then, you need to run "yarn install" and "yarn start" for testing purposes. To deploy the website (keep in mind, that this website communicates with another localhost instance) use "yarn build" for building the web application and use the output in the 'dist' directory.</li>
28 <li>The Documentation<br>The documentation is available under the gnunet-rest-api.git repository (GNUnet REST API Docmentation Git). Clone the repository and "make html". Then open the 'index.html' under 'build/html/'.</li>
29</ol>
30<p>
31 Please, give it a try and contact me, if you find any bugs or unintentional features. ;)
32</p>
33<h4>What can be improved?</h4>
34<p>
35 Right now, the build process of the web application may be a little too complex for a casual user. We may be able to solve this by using docker. Additionally, the web application does not prevent wrong inputs but responds with error messages. Adding GNUnet Records is currently only usable for people, who know how a GNS Record looks like. This can be adapted to each record type. Last but not least, additional features, design changes, etc...
36</p>
37<p>
38 Thanks for reading.
39</p>
40{% endblock body_content %}
diff --git a/template/gsoc-2018-gnunet-webui.html.j2 b/template/gsoc-2018-gnunet-webui.html.j2
index ada000f4..ec65ee5b 100644
--- a/template/gsoc-2018-gnunet-webui.html.j2
+++ b/template/gsoc-2018-gnunet-webui.html.j2
@@ -4,7 +4,7 @@
4 <div class="container"> 4 <div class="container">
5 <div class="text-center"> 5 <div class="text-center">
6 <header> 6 <header>
7 <h1>{{ _("GSoC 2018: GNUnet WebUI") }}</h1> 7 <h1>{{ _("GSoC 2018: GNUnet WebUI (GNUnet Web-based User Interface)") }}</h1>
8 </header> 8 </header>
9 <br /> 9 <br />
10 <p> 10 <p>
@@ -13,21 +13,21 @@
13 {% endtrans %} 13 {% endtrans %}
14 </p> 14 </p>
15 </div> 15 </div>
16 <h4>What was done?</h4>
16 <p> 17 <p>
17 {% trans %} 18 {% trans %}
18 <strong>What was done?</strong><br />
19 In the context of Google Summer of Code 2018, my mentor 19 In the context of Google Summer of Code 2018, my mentor
20 (Martin Schanzenbach) and I have worked on creating and 20 (Martin Schanzenbach) and I have worked on creating and
21 extending the REST API of GNUnet. Currently, we mirrored 21 extending the REST API of GNUnet. Currently, we mirrored
22 the functionality of following commands: 22 the functionality of following commands:
23 {% endtrans %} 23 {% endtrans %}
24 </p> 24 </p>
25 <p> 25 <ul>
26 gnunet-identity<br /> 26 <li>gnunet-identity</li>
27 gnunet-namestore<br /> 27 <li>gnunet-namestore</li>
28 gnunet-gns<br /> 28 <li>gnunet-gns</li>
29 gnunet-peerinfo 29 <li>gnunet-peerinfo</li>
30 </p> 30 </ul>
31 <p> 31 <p>
32 {% trans %} 32 {% trans %}
33 Additionally, we developed a website with the Javascript 33 Additionally, we developed a website with the Javascript
@@ -36,32 +36,33 @@
36 with Sphinx. 36 with Sphinx.
37 {% endtrans %} 37 {% endtrans %}
38 </p> 38 </p>
39 <h4>Why did we create a REST API?</h4>
39 <p> 40 <p>
40 {% trans %} 41 {% trans %}
41 <strong>Why did we create a REST API?</strong><br /> 42 ... when you can use the command line tools? We need to
42 ... when you can use the command line tools?<br /> 43 keep in mind, that everyone has the right to stay secure and
43 We need to keep in mind, that everyone has the right to stay secure 44 private but not everyone feels comfortable using a
44 and private but not everyone feels comfortable using a terminal. The 45 terminal. The further developed REST access to GNUnet APIs
45 further developed REST access to GNUnet APIs in addition to the new 46 in addition to the new web application allows new users to
46 web application allows new users to interact with GNUnet over a well 47 interact with GNUnet over a well known tool: their
47 known tool: their browsers. This addition to the C API and the command 48 browsers. This addition to the C API and the command line
48 line tools may attract new users and developers. 49 tools may attract new users and developers.
49 {% endtrans %} 50 {% endtrans %}
50 </p> 51 </p>
51 <p> 52 <h4>How can we use it?</h4>
52 {% trans %} 53 <ol>
53 <strong>How can we use it?</strong><br />
54 1. The REST API developed in GNUnet<br /> The REST API is
55 already merged into the gnunet.git repository
56 (<a href="https://gnunet.org/git/gnunet.git/">GNUnet Main Git</a>).<br />
57 To use the new features, clone the repository
58 and follow the <a href="https://gnunet.org/en/install.html">Installation</a>
59 on gnunet.org. Then, start the rest service with "gnunet-arm -i rest".
60 {% endtrans %}
61 </p>
62 <p>
63 {% trans %} 54 {% trans %}
64 2. The Web Application<br /> 55 <li>
56 The REST API developed in GNUnet<br> The REST API is
57 already merged into the gnunet.git repository
58 (<a href="https://gnunet.org/git/gnunet.git/">GNUnet Main Git</a>).<br />
59 To use the new features, clone the repository and follow
60 the <a href="https://gnunet.org/en/install.html">Installation</a>
61 on gnunet.org. Then, start the rest service with
62 "gnunet-arm -i rest".
63 </li>
64 <li>
65 The Web Application<br>
65 The web application is available under the gnunet-webui.git 66 The web application is available under the gnunet-webui.git
66 repository 67 repository
67 (<a href="https://gnunet.org/git/gnunet-webui.git/">GNUnet WebUI Git</a>).<br /> 68 (<a href="https://gnunet.org/git/gnunet-webui.git/">GNUnet WebUI Git</a>).<br />
@@ -74,28 +75,27 @@
74 in mind, that this website communicates with another localhost 75 in mind, that this website communicates with another localhost
75 instance) use "yarn build" for building the web application 76 instance) use "yarn build" for building the web application
76 and use the output in the 'dist' directory. 77 and use the output in the 'dist' directory.
77 {% endtrans %} 78 </li>
78 </p> 79 <li>
79 <p> 80 The Documentation<br />
80 {% trans %}
81 3. The Documentation<br />
82 The documentation is available under the gnunet-rest-api.git 81 The documentation is available under the gnunet-rest-api.git
83 repository 82 repository
84 (<a href="https://gnunet.org/git/gnunet-rest-api.git/">GNUnet REST API Docmentation Git</a>).<br /> 83 (<a href="https://gnunet.org/git/gnunet-rest-api.git/">GNUnet REST API Docmentation Git</a>).<br />
85 Clone the repository 84 Clone the repository
86 and "make html". Then open the 'index.html' under 85 and "make html". Then open the 'index.html' under
87 'build/html/'. 86 'build/html/'.
88 {% endtrans %} 87 </li>
89 </p> 88 {% endtrans %}
89 </ol>
90 <p> 90 <p>
91 {% trans %} 91 {% trans %}
92 Please, give it a try and contact me, if you find any 92 Please, give it a try and contact me, if you find any
93 bugs or unintentional features. ;) 93 bugs or unintentional features. ;)
94 {% endtrans %} 94 {% endtrans %}
95 </p> 95 </p>
96 <h4>What can be improved?</h4>
96 <p> 97 <p>
97 {% trans %} 98 {% trans %}
98 <strong>What can be improved?</strong><br />
99 Right now, the build process of the web application may be a 99 Right now, the build process of the web application may be a
100 little too complex for a casual user. We may be able to solve 100 little too complex for a casual user. We may be able to solve
101 this by using docker.<br /> Additionally, the web application 101 this by using docker.<br /> Additionally, the web application
diff --git a/www.yml b/www.yml
index 03f654ab..2b61768a 100644
--- a/www.yml
+++ b/www.yml
@@ -136,11 +136,6 @@ newsposts:
136 title: Google Summer of Code 2019 136 title: Google Summer of Code 2019
137 abstract: 137 abstract:
138 content: 138 content:
139 - page: 2018-08.html
140 date: 2018-08-14
141 title: GSoC 2018 - GNUnet Web-based User Interface
142 abstract:
143 content:
144 - page: 2018-07.html 139 - page: 2018-07.html
145 date: 2018-07-01 140 date: 2018-07-01
146 title: Second GNUnet Hacker Meeting 2018 141 title: Second GNUnet Hacker Meeting 2018