You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
18
19
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
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)
33
31
34
32
## 1. Setup Instructions
35
33
@@ -67,11 +65,15 @@ PASS is currently in Development heading towards [Minimum Viable Product](./docs
67
65
```
68
66
npm install
69
67
```
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:
71
73
```
72
74
npm run dev
73
75
```
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.
75
77
76
78
-### Setting up a Development Pod Server
77
79
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
92
94
93
95
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`
94
96
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
-
101
97
## 2. Project Overview
102
98
103
99
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.
104
100
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
-
136
101
## 3. Contribution Guidelines
137
102
138
103
- Start by checking out the detailed on-boarding [CONTRIBUTING.md](./docs/CONTRIBUTING.md).
139
104
- Join our [Discord](https://discord.gg/Ts923xaUYV) and self assign roles as you see fit. [](https://discord.gg/Ts923xaUYV)
140
105
- Request git-hub access on Discord in the [github-access-request](https://discord.com/channels/1068260532806766733/1078124139983945858) channel of the General category.
141
106
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 |
0 commit comments