Skip to content

Commit e88319f

Browse files
authored
Merge pull request #480 from codeforpdx/Development
Version Update from v0.9.0 to v0.10.0
2 parents 0ccb17a + f9b5a98 commit e88319f

File tree

111 files changed

+3129
-2070
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+3129
-2070
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,24 @@ about: Create a report to help us improve
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
### Bug Title:
11-
Please provide a CONCISE description of the bug.
12-
13-
---
149
### Bug Description:
1510
Please provide a DETAILED description of the bug.
1611

17-
---
1812
### Reproduction Steps:
1913
**1.**
2014
**2.** If needed, delete if not
2115
**3.** If needed, delete if not
2216

23-
---
2417
### Expected Behavior:
2518
What should have happened if the bug didn't occur.
2619

27-
---
28-
### Actual Behavior:
29-
What actually happened, and how it differed from the expected behavior.
30-
31-
---
3220
### Screenshots (If applicable):
3321
If possible, add screenshots to help explain the problem.
3422

35-
---
36-
### Desktop (please complete the following information):
37-
- OS: [e.g. iOS]
38-
- Browser [e.g. chrome, safari]
39-
- Version [e.g. 22]
40-
41-
---
42-
### Smartphone (please complete the following information):
43-
- Device: [e.g. iPhone6]
44-
- OS: [e.g. iOS8.1]
45-
- Browser [e.g. stock browser, safari]
46-
- Version [e.g. 22]
47-
48-
---
4923
### Additional Context (optional):
5024
Add any other context about the problem here.
5125

52-
---
5326
### Possible Solution (optional):
5427
If you have a suggestion on how to fix this bug.

.github/ISSUE_TEMPLATE/enhancement_request.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,19 @@ about: Suggest an enhancement for this project
44
title: 'Enhancement: [Your Title Here]'
55
labels: enhancement
66
assignees: ''
7-
87
---
98

109
### Describe the Current Behavior/Feature:
1110
Provide a clear and concise description of the current behavior or feature.
1211

13-
---
1412
### Proposed Behavior/Feature:
1513
A clear and concise description of the enhancement you want.
1614

17-
---
1815
### Rationale:
1916
Please outline why this enhancement is needed and how it will benefit the project.
2017

21-
---
2218
### Proposed Implementation (if applicable):
2319
Provide a detailed low level description of how you propose the enhancement should be implemented.
2420

25-
---
2621
### Additional context:
2722
Add any other context or screenshots about the enhancement request here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,22 @@ about: Suggest an idea for this project
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
11-
### Feature Title:
12-
Please provide a CONCISE description of the proposed feature.
13-
14-
---
159
### Feature Description:
1610
Please provide a DETAILED description of the proposed feature.
1711

18-
---
1912
### Use Case:
2013
Explain when and why this feature would be used. Try to include as much detail as possible.
2114

22-
---
2315
### Proposed Solution:
2416
If you have a solution in mind, please outline it here.
2517

26-
---
2718
### Alternative Solutions:
2819
If there are alternative ways to solve this problem, please list them here.
2920

30-
---
3121
### Screenshots (if applicable):
3222
Include any screenshots that may be helpful.
3323

34-
---
3524
### Additional Context:
3625
Please provide any other information that might be helpful.

.github/pull_request_template.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,20 @@
1-
## CONCISE description of PR (PR Title)
2-
3-
---
41
## This PR:
52
Resolves #(put issue number here to link this PR to it)
63

74
**1.**
85
**2.** If needed, delete if not
96
**3.** If needed, delete if not
107

11-
---
12-
## The files this PR effects:
13-
14-
### Components
15-
List file names here
16-
17-
### Tests
18-
List file names here
19-
20-
### Other Files
21-
List file names here
22-
23-
---
248
## Screenshots (if applicable):
259
Add any screenshots/videos here.
2610

27-
---
2811
## Additional Context (optional):
2912
Add any other context about the PR here.
3013

31-
---
3214
## Future Steps/PRs Needed to Finish This Work (optional):
3315
Add any other steps/PRs that may be needed to continue this work if this PR is just a step in the right direction.
3416

35-
---
3617
## Issues needing discussion/feedback (optional):
3718
**1.**
3819
**2.** If needed, delete if not
39-
**3.** If needed, delete if not
20+
**3.** If needed, delete if not

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ bundleStats.html
1818

1919
# environment variables
2020
.env
21+
data/

.husky/pre-commit

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx lint-staged

Dockerfile.react

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Stage 1: Build the React app
2+
FROM node:16 AS build
3+
4+
WORKDIR /app
5+
6+
COPY package*.json ./
7+
RUN npm install
8+
9+
COPY . .
10+
RUN npm run build
11+
12+
# Stage 2: Create a lightweight image to run the app
13+
FROM nginx:alpine
14+
15+
COPY --from=build /app/dist /usr/share/nginx/html
16+
17+
EXPOSE 80
18+
19+
CMD ["nginx", "-g", "daemon off;"]

README.md

Lines changed: 14 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# PASS - Personal Access System for Services
22

3-
<img src ="./public/pass-logo.png" width="175">
3+
<picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/codeforpdx/PASS/wiki/assets/images/PASSLogodarkmode.png" width="50"> <source media="(prefers-color-scheme: light)" srcset="https://github.com/codeforpdx/PASS/wiki/assets/images/PASSLogolightmode.png
4+
" width="50"> <img alt="PASS logo"> </picture>
45

56
[![License](https://img.shields.io/github/license/codeforpdx/PASS)](https://github.com/codeforpdx/PASS/blob/Master/LICENSE)
67
[![Discord](https://img.shields.io/discord/1068260532806766733)](https://discord.gg/Ts923xaUYV)
@@ -16,20 +17,17 @@ Welcome! 👋👋🏿👋🏽👋🏻👋🏾👋🏼
1617

1718
PASS is an open source digital wallet for providing home insecure individuals a safe place to store documents within their control. PASS additionally aims to assist caseworkers with processing and providing documents needed to complete the housing assistance application process.
1819

19-
PASS is currently in Development heading towards [Minimum Viable Product](./docs/ROADMAP.md)
20+
The [PASS wiki](https://github.com/codeforpdx/PASS/wiki) contains detailed information of all things PASS including contribution guidelines, tech stack, information on SOLID, ect...
21+
22+
PASS is currently in development working towards MVP release by generous efforts from [our contributors](https://github.com/codeforpdx/PASS/graphs/contributors
23+
).
2024

2125
## Contents
2226

2327
1. [Setup Instructions](#1-setup-instructions)
2428
2. [Project Overview](#2-project-overview)
25-
- [Terminology](#terminology)
26-
- [Features and usage](#features-and-usage)
2729
3. [Contribution Guidelines](#3-contribution-guidelines)
28-
4. [Contributors](#4-contributors)
29-
5. [Tech Stack and Additional Resources](#5-tech-stack)
30-
6. [Code of Conduct](#6-code-of-conduct)
31-
32-
---
30+
4. [Code of Conduct](#4-code-of-conduct)
3331

3432
## 1. Setup Instructions
3533

@@ -67,11 +65,15 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs
6765
```
6866
npm install
6967
```
70-
3. Run the project:
68+
3. Install the pre-commmit prettier, linter, and test hooks.
69+
```
70+
npm run prepare
71+
```
72+
4. Run the project:
7173
```
7274
npm run dev
7375
```
74-
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.
76+
5. 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.
7577

7678
- ### Setting up a Development Pod Server
7779
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.
@@ -92,82 +94,17 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs
9294

9395
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 `npm run podserver:temp`
9496

95-
Further information can be found in [CONTRIBUTING.md](./docs/CONTRIBUTING.md) & [docs/README.md](./docs/README.md)
96-
97-
**[⬆️ Back to Top](#pass---personal-access-system-for-services)**
98-
99-
---
100-
10197
## 2. Project Overview
10298

10399
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.
104100

105-
### Terminology
106-
107-
- Individual/Client - housing insecure person using services to interact with organizations.
108-
- Organization - housing agencies, landlords, government agencies that will be requesting information from individuals.
109-
- Pod/Wallet - decentralized data/document storage built with Solid API. Individuals and organizations will have certain functionality within their pods.
110-
- Folder/Container - referring to the URI location of document data in ttl files using Solid API with Inrupt's library.
111-
- ACL - Access Control List is used to manage Solid Pods by allowing users to control who can access and modify their data.
112-
113-
### Features and Usage
114-
115-
1. Individual/Client
116-
- Upload and Maintain Documents
117-
- Able to share documents
118-
- Can copy verified documents into pod from organization(s)
119-
- Messaging to organizations
120-
2. Organization
121-
- Can request and review documents
122-
- Can create verified documents
123-
- Can place files into clients pod with permission
124-
- Able to share verified documents with clients
125-
- Will have several users per organization
126-
127-
- User registers for a WebID (similar to an email address)
128-
- User authorizes applications and other users to read/write/control data in pod
129-
- User data remains in their pod (which is associated to WebID)
130-
- Full product road map [here](docs/ROADMAP.md)
131-
132-
**[⬆️ Back to Top](#pass---personal-access-system-for-services)**
133-
134-
---
135-
136101
## 3. Contribution Guidelines
137102

138103
- Start by checking out the detailed on-boarding [CONTRIBUTING.md](./docs/CONTRIBUTING.md).
139104
- 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)
140105
- Request git-hub access on Discord in the [github-access-request](https://discord.com/channels/1068260532806766733/1078124139983945858) channel of the General category.
141106

142-
**[⬆️ Back to Top](#pass---personal-access-system-for-services)**
143-
144-
---
145-
146-
## 4. Contributors
147-
148-
| Development Team | UI Team | UX Team | Project Management Team |
149-
| ---------------- | ----------- | ----------- | ----------------------- |
150-
| Jared K. \* | Andy W. \* | Gabby P. \* | Florian S. \* |
151-
| Kevin M. | Scott B. \* | Kyle B. \* | Danica B. \* |
152-
| Ka Hung L. \* | Zack | Laura U. \* | Wilfred P. \* |
153-
| Greg W. | Nicholas G. | Shelby P. | Katharine |
154-
| Emily S. | | | |
155-
| Ben C. \* | | | |
156-
| Tim S. \* | | | |
157-
| Brian H. \* | | | |
158-
| Georgia | | | |
159-
| Natalie M. | | | |
160-
| Grac F. | | | |
161-
162-
\* Active Contributors
163-
164-
---
165-
166-
## 5. Tech Stack
167-
168-
- Details on tech used and additional resources in [resources.md](./docs/RESOURCES.md)
169-
170-
## 6. Code of Conduct
107+
## 4. Code of Conduct
171108

172109
- [Code for PDX code of conduct](https://github.com/codeforpdx/codeofconduct/blob/master/README.md)
173110

compose.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
version: '3.8'
2+
3+
services:
4+
react-app:
5+
build:
6+
context: ./
7+
dockerfile: Dockerfile.react # Creates new image for react app
8+
ports:
9+
- "5173:80"
10+
11+
solid-server:
12+
image: solidproject/community-server:latest # Use updated image or create using Dockerfile
13+
restart: always
14+
user: root
15+
ports:
16+
- "3000:3000"
17+
volumes:
18+
- ./data/solid-data:/data
19+
- ./config/solid-server/solid-config.json:/community-server/config/my-config.json
20+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^6.0.0/components/context.jsonld",
3+
"import": [
4+
"css:CommunitySolidServer/config/app/init/default.json",
5+
"css:CommunitySolidServer/config/app/main/default.json",
6+
"css:CommunitySolidServer/config/app/setup/disabled.json",
7+
"css:CommunitySolidServer/config/app/variables/default.json",
8+
"css:CommunitySolidServer/config/http/handler/default.json",
9+
"css:CommunitySolidServer/config/http/middleware/default.json",
10+
"css:CommunitySolidServer/config/http/notifications/websockets.json",
11+
"css:CommunitySolidServer/config/http/server-factory/https.json",
12+
"css:CommunitySolidServer/config/http/static/default.json",
13+
"css:CommunitySolidServer/config/identity/access/public.json",
14+
"css:CommunitySolidServer/config/identity/email/default.json",
15+
"css:CommunitySolidServer/config/identity/handler/default.json",
16+
"css:CommunitySolidServer/config/identity/ownership/unsafe-no-check.json",
17+
"css:CommunitySolidServer/config/identity/pod/static.json",
18+
"css:CommunitySolidServer/config/identity/registration/enabled.json",
19+
"css:CommunitySolidServer/config/ldp/authentication/dpop-bearer.json",
20+
"css:CommunitySolidServer/config/ldp/authorization/allow-all.json",
21+
"css:CommunitySolidServer/config/ldp/handler/default.json",
22+
"css:CommunitySolidServer/config/ldp/metadata-parser/default.json",
23+
"css:CommunitySolidServer/config/ldp/metadata-writer/default.json",
24+
"css:CommunitySolidServer/config/ldp/modes/default.json",
25+
"css:CommunitySolidServer/config/storage/backend/file.json",
26+
"css:CommunitySolidServer/config/storage/key-value/resource-store.json",
27+
"css:CommunitySolidServer/config/storage/middleware/default.json",
28+
"css:CommunitySolidServer/config/util/auxiliary/empty.json",
29+
"css:CommunitySolidServer/config/util/identifiers/suffix.json",
30+
"css:CommunitySolidServer/config/util/index/default.json",
31+
"css:CommunitySolidServer/config/util/logging/winston.json",
32+
"css:CommunitySolidServer/config/util/representation-conversion/default.json",
33+
"css:CommunitySolidServer/config/util/resource-locker/file.json",
34+
"css:CommunitySolidServer/config/util/variables/default.json"
35+
],
36+
"@graph": [],
37+
}

0 commit comments

Comments
 (0)