Merge pull request #397 from codeforpdx/Development

Version Update from v0.8.0 to v0.9.0

.eslintrc.js

@@ -38,7 +38,8 @@ module.exports = {
           ['@contexts', './src/contexts'],
           ['@pages', './src/pages'],
           ['@utils', './src/utils'],
-          ['@components', './src/components']
+          ['@components', './src/components'],
+          ['@constants', './src/constants']
         ]
       }
     }

.github/pull_request_template.md

@@ -1,16 +1,9 @@
----
-name: Pull Request
-about: Create a pull request to merge your code into the PASS codebase
-title: ''
-labels: ''
-assignees: ''
-
----
-
 ## CONCISE description of PR (PR Title)
 
 ---
 ## This PR:
+Resolves #(put issue number here to link this PR to it) 
+
 **1.**    
 **2.** If needed, delete if not    
 **3.** If needed, delete if not

README.md

@@ -1,7 +1,6 @@
-
 # PASS - Personal Access System for Services
 
-<img src ="./src/assets/logo.png" width="175">
+<img src ="./public/pass-logo.png" width="175">
 
 [![License](https://img.shields.io/github/license/codeforpdx/PASS)](https://github.com/codeforpdx/PASS/blob/Master/LICENSE)
 [![Discord](https://img.shields.io/discord/1068260532806766733)](https://discord.gg/Ts923xaUYV)
@@ -23,29 +22,31 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs
 
 1.  [Setup Instructions](#1-setup-instructions)
 2.  [Project Overview](#2-project-overview)
-       - [Terminology](#terminology)
-       - [Features and usage](#features-and-usage)
+    - [Terminology](#terminology)
+    - [Features and usage](#features-and-usage)
 3.  [Contribution Guidelines](#3-contribution-guidelines)
 4.  [Contributors](#4-contributors)
 5.  [Tech Stack and Additional Resources](#5-tech-stack)
 6.  [Code of Conduct](#6-code-of-conduct)
 
 ---
+
 ## 1. Setup Instructions
 
 - ### Prerequisites
 
-   Currently we require Node version 16 or higher and NPM for our package manager.  Most places recommend using a node version manager to install node and npm. To proceed using NVM perform the following.. 
+  Currently we require Node version 16 or higher and NPM for our package manager. Most places recommend using a node version manager to install node and npm. To proceed using NVM perform the following..
+
+1. Download NVM for your system.
 
-1. Download NVM for your system. 
-  - For Mac, Linux, and other POSIX users: https://github.com/nvm-sh/nvm 
-  - For Windows users: https://github.com/coreybutler/nvm-windows
-
-2. Install node version 16: 
+- For Mac, Linux, and other POSIX users: https://github.com/nvm-sh/nvm
+- For Windows users: https://github.com/coreybutler/nvm-windows
+
+2. Install node version 16:
    ```
    nvm install 16
    ```
-3. Use that node version: 
+3. Use that node version:
    ```
    nvm use 16
    ```
@@ -57,32 +58,31 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs
    If either of those commands error, node has not been installed correctly.
 
 - ### Clone and Install Dependencies
-  
-1. Clone the git repository: 
+
+1. Clone the git repository:
    ```
    git clone https://github.com/codeforpdx/PASS.git
    ```
-
 2. Install project dependencies:
    ```
    npm install
    ```
-3. Run the project: 
+3. Run the project:
    ```
    npm run dev
    ```
 4. PASS should launch at `http://localhost:5173`. You can now visit that url, and sign into a pod hosted at the OIDC provider of your choice.
 
 - ### Setting up a Development Pod Server
-
-   PASS is able to connect to any solid-spec compliant pod server. However, for testing, it's recommended that you run a server locally. PASS provides tools to make this easy to do.
+  PASS is able to connect to any solid-spec compliant pod server. However, for testing, it's recommended that you run a server locally. PASS provides tools to make this easy to do.
 
 1. Clone and install dependencies. [See previous section](#clone-and-install-dependencies)
 
 2. In the project's root directory, copy the `env.template` file into a `.env` file. In bash you can use this command:
-    ```bash
-    cp env.template .env
-    ```
+
+   ```bash
+   cp env.template .env
+   ```
 
 3. Run `npm run podserver` to launch the pod server. The server will begin listening on `http://localhost:3000`, and will create a folder in the PASS project folder called `local_temp_server_files`. You can find all server and pod files there.
 
@@ -102,7 +102,7 @@ Further information can be found in [CONTRIBUTING.md](./docs/CONTRIBUTING.md) &
 
 In Portland, housing insecure individuals struggle to maintain documents often required to receive government and/or non-profit services. With PASS, we are building out an application to enable housing insecure individuals to store their personal documents in decentralized data stores, called Pods. PASS will also provide a platform for Organizations to assist with providing and processing documents required for housing assistance. Using [Solid Data Pods](https://solidproject.org/) individuals will have control over which organizations and applications can access their data. Verified organizations will be able to use PASS to request data from an individual and/or add documents (such as references or invoices) to an individuals pod to help process housing assistance applications.
 
-###  Terminology
+### Terminology
 
 - Individual/Client - housing insecure person using services to interact with organizations.
 - Organization - housing agencies, landlords, government agencies that will be requesting information from individuals.
@@ -128,17 +128,17 @@ In Portland, housing insecure individuals struggle to maintain documents often r
 - User authorizes applications and other users to read/write/control data in pod
 - User data remains in their pod (which is associated to WebID)
 - Full product road map [here](docs/ROADMAP.md)
-  
+
 **[⬆️ Back to Top](#pass---personal-access-system-for-services)**
 
 ---
 
 ## 3. Contribution Guidelines
 
--  Start by checking out the detailed on-boarding [CONTRIBUTING.md](./docs/CONTRIBUTING.md).
--  Join our [Discord](https://discord.gg/Ts923xaUYV) and self assign roles as you see fit. [![Discord](https://img.shields.io/discord/1068260532806766733)](https://discord.gg/Ts923xaUYV)
--  Request git-hub access on Discord in the [github-access-request](https://discord.com/channels/1068260532806766733/1078124139983945858) channel of the General category.
-  
+- Start by checking out the detailed on-boarding [CONTRIBUTING.md](./docs/CONTRIBUTING.md).
+- Join our [Discord](https://discord.gg/Ts923xaUYV) and self assign roles as you see fit. [![Discord](https://img.shields.io/discord/1068260532806766733)](https://discord.gg/Ts923xaUYV)
+- Request git-hub access on Discord in the [github-access-request](https://discord.com/channels/1068260532806766733/1078124139983945858) channel of the General category.
+
 **[⬆️ Back to Top](#pass---personal-access-system-for-services)**
 
 ---
@@ -171,5 +171,4 @@ In Portland, housing insecure individuals struggle to maintain documents often r
 
 - [Code for PDX code of conduct](https://github.com/codeforpdx/codeofconduct/blob/master/README.md)
 
-
 **[⬆️ Back to Top](#pass---personal-access-system-for-services)**

__mocks__/@inrupt/solid-client.js

@@ -23,3 +23,4 @@ export const getSolidDatasetWithAcl = vi.fn(mockDatasetFactory);
 export const saveSolidDatasetInContainer = vi.fn(() => Promise.resolve());
 export const getFile = vi.fn(() => Promise.resolve());
 export const saveFileInContainer = vi.fn(() => Promise.resolve());
+export const getWebIdDataset = vi.fn((url) => Promise.resolve(mockSolidDatasetFrom(url)))

clearDocs.js

@@ -25,8 +25,4 @@ allMds.forEach((mdFile) => {
  * the temp directory as the docs directory,
  * now containing only the original .md files */
 fs.rmSync(docsDir, { recursive: true, force: true });
-fs.renameSync(tempDir, docsDir, (err) => {
-  if (err) {
-    throw err;
-  }
-});
+fs.renameSync(tempDir, docsDir);

docs/README.md

@@ -100,7 +100,7 @@ To do so, you will need to edit the root `.env` file.
 2. Start the SOLID server in a shell window
 
 ```shell
-npm run dev:pod
+npm run podserver
 ```
 
 ---
@@ -120,17 +120,15 @@ PASS is intended to work with any server that implements the SOLID protocol. How
 You can change the port the server is listening on by using the `--port` or `-p` flags:
 
 ```shell
-npm run dev:pod -- -p 1234
+npm run podserver -- -p 1234
 ```
 ---
 
-By default, community solid server stores all data in memory (i.e. it does not save data when it's shut down). To have it store data to your filesystem, you can use the command
+Note: The `npm run podserver` command will launch a server that stores documents on your local file system. If you don't want to store documents, and want all server data to be deleted on shutdown, you can run
 
-```shell
-npm run dev:pod:stored
-```
-
-This will store all server files in the folder `PASS/local_temp_server_files`. This is a local testing directory, and the files within it should not be added to source control.
+ ```shell
+ npm run podserver:temp
+ ```
 
 You can find more information on its configuration on the project's [github](https://github.com/CommunitySolidServer/CommunitySolidServer#configuring-the-server).
 

env.template

@@ -1 +1,2 @@
 VITE_SOLID_IDENTITY_PROVIDER="http://localhost:3000/"
+VITE_SOLID_POD_SERVER="http://localhost:3000/"

index.html

@@ -4,9 +4,8 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="initial-scale=1, width=device-width" />
     <title>Getting Started with PASS</title>
-    <link rel="stylesheet" href="/src/style.css" />
+    <link rel="icon" type="image/x-icon" href="/pass-logo.png" />
   </head>
-
   <body>
     <div id="root"></div>
     <script type="module" defer src="/src/index.jsx"></script>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pass",
   "homepage": ".",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "",
   "scripts": {
     "dev": "vite",
@@ -34,6 +34,7 @@
     "@mui/styled-engine-sc": "^5.12.0",
     "@mui/system": "^5.12.1",
     "@mui/x-date-pickers": "^6.5.0",
+    "@tanstack/react-query": "^4.32.0",
     "@zxing/browser": "^0.1.3",
     "crypto-js": "^4.1.1",
     "dayjs": "^1.11.8",