Merge pull request #25 from ecrum19/EDC_active

changed CSS landing page and updated readme/instructions
KNowledgeOnWebScale · Jun 28, 2024 · 714dc01 · 714dc01
2 parents 0fce911 + 990f450
commit 714dc01
Show file tree

Hide file tree

Showing 13 changed files with 195 additions and 136 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
 .DS_Store
 node_modules
-.data/
+.data/*
+tsconfig.*.json
+docs/
 
 # local env files
 .env.local

diff --git a/README.md b/README.md
@@ -15,6 +15,16 @@
 
    `https://ecrum19.github.io/TRIPLE_App/`
 
+2. Clone this git repo
+
+   `git clone https://github.com/ecrum19/TRIPLE_App.git`
+
+3. Navigate to the created directory
+
+   `cd TRIPLE_App/`
+
+4. Follow the instructions on the home page of the [TRIPLE App](ecrum19.github.io/TRIPLE_App/) website!
+
 
 #### Notes:
 **General issues:**

diff --git a/config/entrance.html b/config/entrance.html
@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8"/>
+  <meta name="viewport" content="width=device-width, initial-scale=1"/>
+  <title>Community Solid Server</title>
+  <link rel="stylesheet" href="/.well-known/css/styles/main.css" type="text/css">
+</head>
+<body>
+  <header>
+    <a href=".."><img src="/.well-known/css/images/solid.svg" alt="[Solid logo]" /></a>
+    <h1>Community Solid Server</h1>
+  </header>
+  <main>
+    <h4>
+      This server implements
+      the <a href="https://solid.github.io/specification/protocol">Solid protocol</a>
+      for creating your own <a href="https://solidproject.org/about">Solid Pod</a>
+      and identity.
+    </h4>
+
+    <br><br>
+
+    <h2 id="users"
+      >Select one of these options to get started!
+    </h2>
+
+    <p id="registration-enabled">
+      <div class="button-container">
+        <a id="login-link" href="./.account/login/password/" class="modern-button">
+          <span id="login">Login</span><br>(Already registered)</a>
+        <a id="registration-link" href="./.account/login/password/register/" class="modern-button">
+          <span id="signup">Sign up</span><br>(No account yet)</a>
+      </div>
+    </p>
+
+    <br><br><br>
+
+    <p>
+      <strong>This is a custom Community Solid Server landing page made for the
+        <a href="https://ecrum19.github.io/TRIPLE_App/">TRIPLE App</a>.</strong>
+    </p>
+
+    <p>
+      If interested, learn more about the <a href="https://solidproject.org/">Solid Project</a> 
+      or the <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/">Community Solid Server</a>.
+    </p>
+    <p>
+      You are warmly invited
+      to <a href="https://github.com/ecrum19/TRIPLE_App/discussions">share your experiences</a>
+      and to <a href="https://github.com/ecrum19/TRIPLE_App/issues">report any bugs</a> you encounter.
+    </p>
+
+  </main>
+
+  <footer>
+    <p>
+      ©2019–2024 <a href="https://inrupt.com/">Inrupt Inc.</a>
+      and <a href="https://www.imec-int.com/">imec</a>
+    </p>
+  </footer>
+</body>
+
+<script>
+  (async() => {
+    // Since this page is in the root of the server, we can determine other URLs relative to the current URL
+    const res = await fetch('.account/');
+    const registrationUrl = (await res.json())?.controls?.html?.password?.register;
+    // We specifically want to check if the HTML page that we link to exists
+    const resRegistrationPage = await fetch(registrationUrl, { headers: { accept: 'text/html' } });
+    const registrationEnabled = registrationUrl && resRegistrationPage.status === 200;
+
+    document.getElementById('registration-enabled').classList[registrationEnabled ? 'remove' : 'add']('hidden');
+    document.getElementById('registration-link').href = registrationUrl;
+  })();
+</script>
+
+<style scoped>
+
+/* Container to display buttons side-by-side */
+.button-container {
+  display: flex;
+  justify-content: space-around; /* Adjusts spacing between buttons */
+  padding: 15px; /* Adds some padding around the buttons */
+}
+
+/* Makes buttons look like buttons */
+.modern-button {
+  background-color: #7C4DFF; /* Purple background */
+  color: white; /* White text */
+  text-decoration: none; /* Removes underline from links */
+  padding: 20px 40px; /* Increases top and bottom padding, Left and right padding to make buttons larger */
+  flex-grow: 1; /* Allows the button to grow to fill the space */
+  border-radius: 2px; /* More rounded corners */
+  text-align: center; /* Centers text horizontally */
+  margin: 0 10px; /* Adds margin to ensure buttons don't touch */
+  cursor: pointer;
+}
+
+#login, #signup {
+  font-size: 26pt;
+}
+
+/* Button hover color */
+.modern-button:hover {
+  background-color: #18a9e6;
+  color: white; /* White text */
+}
+
+/* Adjust margin for the first and last buttons for better spacing */
+.button-container > .modern-button:first-child {
+  margin-left: 0;
+}
+
+.button-container > .modern-button:last-child {
+  margin-right: 0;
+}
+</style>
+</html>
diff --git a/config/tripleCSS-config.json b/config/tripleCSS-config.json
@@ -0,0 +1,46 @@
+{
+  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^7.0.0/components/context.jsonld",
+  "import": [
+    "css:config/app/init/static-root.json",
+    "css:config/app/main/default.json",
+    "css:config/app/variables/default.json",
+    "css:config/http/handler/default.json",
+    "css:config/http/middleware/default.json",
+    "css:config/http/notifications/all.json",
+    "css:config/http/server-factory/http.json",
+    "css:config/http/static/default.json",
+    "css:config/identity/access/public.json",
+    "css:config/identity/email/default.json",
+    "css:config/identity/handler/default.json",
+    "css:config/identity/oidc/default.json",
+    "css:config/identity/ownership/token.json",
+    "css:config/identity/pod/static.json",
+    "css:config/ldp/authentication/dpop-bearer.json",
+    "css:config/ldp/authorization/webacl.json",
+    "css:config/ldp/handler/default.json",
+    "css:config/ldp/metadata-parser/default.json",
+    "css:config/ldp/metadata-writer/default.json",
+    "css:config/ldp/modes/default.json",
+    "css:config/storage/backend/file.json",
+    "css:config/storage/key-value/resource-store.json",
+    "css:config/storage/location/pod.json",
+    "css:config/storage/middleware/default.json",
+    "css:config/util/auxiliary/acl.json",
+    "css:config/util/identifiers/suffix.json",
+    "css:config/util/index/default.json",
+    "css:config/util/logging/winston.json",
+    "css:config/util/representation-conversion/default.json",
+    "css:config/util/resource-locker/file.json",
+    "css:config/util/variables/default.json"
+  ],
+  "@graph": [
+    {
+      "@type": "Override",
+      "overrideInstance": { "@id": "urn:solid-server:default:RootStaticAsset" },
+      "overrideParameters": {
+        "@type": "StaticAssetEntry",
+        "filePath": "config/entrance.html"
+      }
+    }
+  ]
+}
diff --git a/docs/css/app.e4a9335f.css b/docs/css/app.e4a9335f.css
diff --git a/docs/css/chunk-vendors.03a4ccdb.css b/docs/css/chunk-vendors.03a4ccdb.css
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/js/app.9719963f.js b/docs/js/app.9719963f.js
diff --git a/docs/js/app.9719963f.js.map b/docs/js/app.9719963f.js.map
diff --git a/docs/js/chunk-vendors.4e9e7f21.js b/docs/js/chunk-vendors.4e9e7f21.js
diff --git a/docs/js/chunk-vendors.4e9e7f21.js.map b/docs/js/chunk-vendors.4e9e7f21.js.map
diff --git a/makePod.sh b/makePod.sh
@@ -1,11 +1,5 @@
 #!/bin/bash
+current_directory=$(pwd)
 
-npx @solid/community-server -p 3000 -c @css:config/file.json -f .data
-
-
-# if ls "$(pwd)/.data" >dev/null 2>&1; then
-    # start existing CSS instance ??
-# else 
-    # install CSS
-    # start CSS instance??
-# fi
+# launches 
+npx @solid/community-server -p 3000 -c $current_directory/config/tripleCSS-config.json -f .data
diff --git a/src/components/LandingPage.vue b/src/components/LandingPage.vue
@@ -57,20 +57,20 @@
       <ol>
         <li>
           Using a web browser navigate to
-          <a href="http://localhost:3000/">http://localhost:3000/</a>
+          <b><a href="http://localhost:3000/" target="_blank">http://localhost:3000/</a></b>
         </li>
-        <li>Click the link: <b>"Sign up for an account"</b></li>
-        <li>Fill out the fields and click <b>"Register"</b></li>
-        <li>On the <b>"Your Account"</b> page, click on <b>"Create pod"</b></li>
+        <li>Either <b><a href="http://localhost:3000/.account/login/password/register/" target="_blank">"Sign up"</a></b> or 
+          <b><a href="http://localhost:3000/.account/login/password/" target="_blank">"Login"</a></b></li>
+        <li>Once on the <b>"Your Account"</b> page, click on <b>"Create pod"</b></li>
         <li>Enter a name for the pod and click <b>"Create pod"</b></li>
         <li>Return to the home page by clicking <b>"Back"</b></li>
       </ol>
       <p>
-        <b>Voila</b>, you now have a pod hosted by your local machine!<br />
+        <b>Voila</b>, now you a pod! <strong>Time to return to the command line </strong>(briefly).<br />
         <span class="detail">
-          (Please note that if the terminal window you executed the bash script above is terminated, 
-          the Solid pod will no longer be accessible until it is re-launched. For more info
-          see
+          (Please note that if the terminal window you executed the bash script [in step <b>1</b>-II] is terminated, 
+          the Solid pod will no longer be accessible until it is re-launched (return to step <b>1</b>-II). 
+          For more info see
           <a
             href="https://communitysolidserver.github.io/CommunitySolidServer/latest/"
             >Community Solid Server Documentation</a
@@ -86,7 +86,12 @@
         <pre><code>$ bash podRegistration.sh</code></pre>
         <li>At the prompt, enter the name of your pod from above (E.g. test)</li>
       </ol>
-
+      <p>
+        Great, now <strong>we are finished with set-up!!</strong> 
+        Return to the 
+        <a href="https://ecrum19.github.io/TRIPLE_App/">Triple App</a> 
+        for the next steps.<br />
+      </p>
       <hr />
 
       <h2 class="req">4. Solid Pod Login within the TRIPLE App</h2>