Skip to content

Commit

Permalink
Merge pull request #480 from codeforpdx/Development
Browse files Browse the repository at this point in the history
Version Update from v0.9.0 to v0.10.0
  • Loading branch information
leekahung authored Oct 25, 2023
2 parents 0ccb17a + f9b5a98 commit e88319f
Show file tree
Hide file tree
Showing 111 changed files with 3,129 additions and 2,070 deletions.
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,24 @@ about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

### Bug Title:
Please provide a CONCISE description of the bug.

---
### Bug Description:
Please provide a DETAILED description of the bug.

---
### Reproduction Steps:
**1.**
**2.** If needed, delete if not
**3.** If needed, delete if not

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

---
### Actual Behavior:
What actually happened, and how it differed from the expected behavior.

---
### Screenshots (If applicable):
If possible, add screenshots to help explain the problem.

---
### Desktop (please complete the following information):
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

---
### Smartphone (please complete the following information):
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

---
### Additional Context (optional):
Add any other context about the problem here.

---
### Possible Solution (optional):
If you have a suggestion on how to fix this bug.
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,19 @@ about: Suggest an enhancement for this project
title: 'Enhancement: [Your Title Here]'
labels: enhancement
assignees: ''

---

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

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

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

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

---
### Additional context:
Add any other context or screenshots about the enhancement request here.
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,22 @@ about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---


### Feature Title:
Please provide a CONCISE description of the proposed feature.

---
### Feature Description:
Please provide a DETAILED description of the proposed feature.

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

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

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

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

---
### Additional Context:
Please provide any other information that might be helpful.
21 changes: 1 addition & 20 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,20 @@
## 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

---
## The files this PR effects:

### Components
List file names here

### Tests
List file names here

### Other Files
List file names here

---
## Screenshots (if applicable):
Add any screenshots/videos here.

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

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

---
## Issues needing discussion/feedback (optional):
**1.**
**2.** If needed, delete if not
**3.** If needed, delete if not
**3.** If needed, delete if not
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ bundleStats.html

# environment variables
.env
data/
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx lint-staged
19 changes: 19 additions & 0 deletions Dockerfile.react
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Stage 1: Build the React app
FROM node:16 AS build

WORKDIR /app

COPY package*.json ./
RUN npm install

COPY . .
RUN npm run build

# Stage 2: Create a lightweight image to run the app
FROM nginx:alpine

COPY --from=build /app/dist /usr/share/nginx/html

EXPOSE 80

CMD ["nginx", "-g", "daemon off;"]
91 changes: 14 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# PASS - Personal Access System for Services

<img src ="./public/pass-logo.png" width="175">
<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
" width="50"> <img alt="PASS logo"> </picture>

[![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)
Expand All @@ -16,20 +17,17 @@ Welcome! 👋👋🏿👋🏽👋🏻👋🏾👋🏼

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.

PASS is currently in Development heading towards [Minimum Viable Product](./docs/ROADMAP.md)
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...

PASS is currently in development working towards MVP release by generous efforts from [our contributors](https://github.com/codeforpdx/PASS/graphs/contributors
).

## Contents

1. [Setup Instructions](#1-setup-instructions)
2. [Project Overview](#2-project-overview)
- [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)

---
4. [Code of Conduct](#4-code-of-conduct)

## 1. Setup Instructions

Expand Down Expand Up @@ -67,11 +65,15 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs
```
npm install
```
3. Run the project:
3. Install the pre-commmit prettier, linter, and test hooks.
```
npm run prepare
```
4. 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.
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.

- ### 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.
Expand All @@ -92,82 +94,17 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs

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`

Further information can be found in [CONTRIBUTING.md](./docs/CONTRIBUTING.md) & [docs/README.md](./docs/README.md)

**[⬆️ Back to Top](#pass---personal-access-system-for-services)**

---

## 2. Project Overview

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

- Individual/Client - housing insecure person using services to interact with organizations.
- Organization - housing agencies, landlords, government agencies that will be requesting information from individuals.
- Pod/Wallet - decentralized data/document storage built with Solid API. Individuals and organizations will have certain functionality within their pods.
- Folder/Container - referring to the URI location of document data in ttl files using Solid API with Inrupt's library.
- ACL - Access Control List is used to manage Solid Pods by allowing users to control who can access and modify their data.

### Features and Usage

1. Individual/Client
- Upload and Maintain Documents
- Able to share documents
- Can copy verified documents into pod from organization(s)
- Messaging to organizations
2. Organization
- Can request and review documents
- Can create verified documents
- Can place files into clients pod with permission
- Able to share verified documents with clients
- Will have several users per organization

- User registers for a WebID (similar to an email address)
- 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.

**[⬆️ Back to Top](#pass---personal-access-system-for-services)**

---

## 4. Contributors

| Development Team | UI Team | UX Team | Project Management Team |
| ---------------- | ----------- | ----------- | ----------------------- |
| Jared K. \* | Andy W. \* | Gabby P. \* | Florian S. \* |
| Kevin M. | Scott B. \* | Kyle B. \* | Danica B. \* |
| Ka Hung L. \* | Zack | Laura U. \* | Wilfred P. \* |
| Greg W. | Nicholas G. | Shelby P. | Katharine |
| Emily S. | | | |
| Ben C. \* | | | |
| Tim S. \* | | | |
| Brian H. \* | | | |
| Georgia | | | |
| Natalie M. | | | |
| Grac F. | | | |

\* Active Contributors

---

## 5. Tech Stack

- Details on tech used and additional resources in [resources.md](./docs/RESOURCES.md)

## 6. Code of Conduct
## 4. Code of Conduct

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

Expand Down
20 changes: 20 additions & 0 deletions compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: '3.8'

services:
react-app:
build:
context: ./
dockerfile: Dockerfile.react # Creates new image for react app
ports:
- "5173:80"

solid-server:
image: solidproject/community-server:latest # Use updated image or create using Dockerfile
restart: always
user: root
ports:
- "3000:3000"
volumes:
- ./data/solid-data:/data
- ./config/solid-server/solid-config.json:/community-server/config/my-config.json

37 changes: 37 additions & 0 deletions config/solid-server/solid-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^6.0.0/components/context.jsonld",
"import": [
"css:CommunitySolidServer/config/app/init/default.json",
"css:CommunitySolidServer/config/app/main/default.json",
"css:CommunitySolidServer/config/app/setup/disabled.json",
"css:CommunitySolidServer/config/app/variables/default.json",
"css:CommunitySolidServer/config/http/handler/default.json",
"css:CommunitySolidServer/config/http/middleware/default.json",
"css:CommunitySolidServer/config/http/notifications/websockets.json",
"css:CommunitySolidServer/config/http/server-factory/https.json",
"css:CommunitySolidServer/config/http/static/default.json",
"css:CommunitySolidServer/config/identity/access/public.json",
"css:CommunitySolidServer/config/identity/email/default.json",
"css:CommunitySolidServer/config/identity/handler/default.json",
"css:CommunitySolidServer/config/identity/ownership/unsafe-no-check.json",
"css:CommunitySolidServer/config/identity/pod/static.json",
"css:CommunitySolidServer/config/identity/registration/enabled.json",
"css:CommunitySolidServer/config/ldp/authentication/dpop-bearer.json",
"css:CommunitySolidServer/config/ldp/authorization/allow-all.json",
"css:CommunitySolidServer/config/ldp/handler/default.json",
"css:CommunitySolidServer/config/ldp/metadata-parser/default.json",
"css:CommunitySolidServer/config/ldp/metadata-writer/default.json",
"css:CommunitySolidServer/config/ldp/modes/default.json",
"css:CommunitySolidServer/config/storage/backend/file.json",
"css:CommunitySolidServer/config/storage/key-value/resource-store.json",
"css:CommunitySolidServer/config/storage/middleware/default.json",
"css:CommunitySolidServer/config/util/auxiliary/empty.json",
"css:CommunitySolidServer/config/util/identifiers/suffix.json",
"css:CommunitySolidServer/config/util/index/default.json",
"css:CommunitySolidServer/config/util/logging/winston.json",
"css:CommunitySolidServer/config/util/representation-conversion/default.json",
"css:CommunitySolidServer/config/util/resource-locker/file.json",
"css:CommunitySolidServer/config/util/variables/default.json"
],
"@graph": [],
}
Loading

0 comments on commit e88319f

Please sign in to comment.