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
Copy file name to clipboardExpand all lines: README.md
+26-20Lines changed: 26 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,36 +31,37 @@ PASS is currently in development working towards MVP release by generous efforts
31
31
32
32
## 1. Quick Setup Instructions
33
33
34
-
**Note**: All commands in this document are for bash. If you are using an incompatible shell like CMD or powershell, you may need to use different commands.
34
+
**Note**: All commands in this document are for bash. If you are using an incompatible shell like CMD or powershell, you may need to use different commands.
35
35
36
-
-### Getting the Code
36
+
-### Getting the Code
37
37
38
38
1. Clone the git repository:
39
39
40
40
```bash
41
41
git clone https://github.com/codeforpdx/PASS.git
42
42
```
43
+
43
44
2. Enter the project folder:
44
-
```bash
45
-
cd PASS
46
-
```
45
+
```bash
46
+
cd PASS
47
+
```
47
48
48
49
-### Setting up Node
49
50
50
-
_If you already have node 18 installed on your system, you may skip this section._
51
+
_If you already have node 20 installed on your system, you may skip this section._
51
52
52
-
Currently, we require Node version 18.19.x and NPM for our package manager. We recommend using Node Version Manager (NVM) to install Node and npm. To proceed using NVM, perform the following:
53
+
Currently, we require Node version 20.xx.x and NPM for our package manager. We recommend using Node Version Manager (NVM) to install Node and npm. To proceed using NVM, perform the following:
53
54
54
55
1. Download NVM for your system.
55
56
56
57
- For Mac, Linux, and other POSIX users: [https://github.com/nvm-sh/nvm](https://github.com/nvm-sh/nvm)
57
58
- For Windows users: [https://github.com/coreybutler/nvm-windows](https://github.com/coreybutler/nvm-windows)
58
59
59
-
2. If you don't have node version 18, install node version 18 by running:
60
+
2. If you don't have node version 20, install node version 20 by running:
60
61
```bash
61
62
nvm install 18
62
63
```
63
-
This will download node 18 and set it up for use
64
+
This will download node 20 and set it up for use
64
65
3. Check that node and npm are set up:
65
66
66
67
```bash
@@ -70,11 +71,12 @@ Currently, we require Node version 18.19.x and NPM for our package manager. We r
70
71
```bash
71
72
npm -v
72
73
```
73
-
The node version should be 18.19 (and maybe third decimal) and the npm version should be 10.2 (and maybe a third decimal). If they are not these versions, or if either of those commands cause an error, node has not been installed correctly.
74
74
75
-
4. We include a `.nvmrc` in the root folder of the project, which contains our target node version. We update this version periodically. If you're ever not sure of what node version you should be using, run
75
+
The node version should be 20.xx (and maybe third decimal) and the npm version should be 10.2 (and maybe a third decimal). If they are not these versions, or if either of those commands cause an error, node has not been installed correctly.
76
+
77
+
4. We include a `.nvmrc` in the root folder of the project, which contains our target node version. We update this version periodically. If you're ever not sure of what node version you should be using, run
76
78
```bash
77
-
nvm use
79
+
nvm use
78
80
```
79
81
to be synced with the project. You may receive warning messages in the terminal if the verion is not installed. Follow the messages to resolve the issues.
80
82
@@ -87,19 +89,22 @@ The node version should be 18.19 (and maybe third decimal) and the npm version s
87
89
```
88
90
89
91
2. Configure the project environment:
90
-
```bash
91
-
cp env.template .env
92
-
```
92
+
93
+
```bash
94
+
cp env.template .env
95
+
```
93
96
94
97
3. Run the following command:
95
-
```bash
96
-
npm start
97
-
```
98
-
To start up everything needed to run PASS.
98
+
99
+
```bash
100
+
npm start
101
+
```
102
+
103
+
To start up everything needed to run PASS.
99
104
100
105
4. Navigate to PASS and set up an account.
101
106
102
-
By default, PASS launches at [http://localhost:5173](http://localhost:5173) on your local machine. Navigate to that screen, then click the signup button to create a pod and web ID for yourself. Then return to the homepage and log in. Follow all prompts that appear, and you will be up and running with PASS!
107
+
By default, PASS launches at [http://localhost:5173](http://localhost:5173) on your local machine. Navigate to that screen, then click the signup button to create a pod and web ID for yourself. Then return to the homepage and log in. Follow all prompts that appear, and you will be up and running with PASS!
103
108
104
109
-### Setting up Git Hooks for development
105
110
@@ -126,6 +131,7 @@ In Portland, housing-insecure individuals struggle to maintain documents often r
126
131
-[CODEPDX code of conduct](https://github.com/codeforpdx/codeofconduct/blob/master/README.md)
127
132
128
133
## 5. PASS Wiki
134
+
129
135
[Visit the wiki for more information on every aspect of the project. Feature set, architecture, tooling, etc](https://github.com/codeforpdx/PASS/wiki)
130
136
131
137
**[⬆️ Back to Top](#pass---personal-access-system-for-services)**
0 commit comments