Skip to content

Commit 79bf51b

Browse files
committed
update Readme
1 parent 05b1229 commit 79bf51b

File tree

1 file changed

+39
-8
lines changed

1 file changed

+39
-8
lines changed

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,52 @@
11
# PassWall Desktop
22

3-
#### Build Setup
3+
<p align="center">
4+
<img src="https://www.yakuter.com/wp-content/yuklemeler/passwall-cover.png" alt="" width="800" height="450" />
5+
</p>
6+
<p align="center">
7+
The <strong>PassWall Desktop</strong> is an Electron Vue application that powers the web vault (https://vault.passwall.io/).
8+
</p>
9+
10+
## Build/Run
11+
12+
### Requirements
13+
14+
- [Node.js](https://nodejs.org)
15+
- [Electron](https://www.electronjs.org)
16+
17+
### Run the app
418

519
``` bash
620
# install dependencies
7-
npm install
21+
yarn
822

923
# serve with hot reload at localhost:9080
10-
npm run dev
24+
yarn run dev
1125

1226
# build electron application for production
13-
npm run build
27+
yarn run build
28+
```
29+
30+
You can adjust your API endpoint settings in `src/renderer/api/HTTPClient.js` by changing the `baseURL`. For example:
1431

15-
# run unit tests
16-
npm test
32+
```js
33+
const client = Axios.create({
34+
baseURL: 'https://vault.passwall.io',
35+
headers: {
36+
'Content-Type': 'application/json; charset=utf-8',
37+
Accept: 'application/json, text/plain, */*'
38+
}
39+
})
40+
```
1741

18-
# lint all JS/Vue component files in `src/`
19-
npm run lint
42+
If you want to point your local passwall server address, you can set:
2043

44+
```js
45+
const client = Axios.create({
46+
baseURL: 'http://localhost:3625',
47+
headers: {
48+
'Content-Type': 'application/json; charset=utf-8',
49+
Accept: 'application/json, text/plain, */*'
50+
}
51+
})
2152
```

0 commit comments

Comments
 (0)