Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
michmzr committed Jun 29, 2023
1 parent ef476c0 commit bd2352c
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,30 @@ App for visualising [GetPocket](https://getpocket.com/) usage stats

### Backend

#### Environment variabled
- BACKEND_URL | default: http://localhost:8080
- POCKET_CONSUMER_KEY
- MONGODB_HOST
- MONGODB_PORT
- MONGODB_USER
- MONGODB_PASS
- MONGODB_DB
- MONGODB_URI
#### Environment variables
- `BACKEND_URL` - backend url, default: http://localhost:8080
- `POCKET_CONSUMER_KEY` - get pocket consumer key
- `MONGODB_HOST` - mongo db host
- `MONGODB_URI` - full mongodb uri with login and pass

example env variables for local instance workig with dockerized MongoDB
```
{
"VUE_APP_BACKEND_URL": "http://127.0.0.1:8081/pocketstats",
"POCKET_CONSUMER_KEY": "[get pocket consumer key]",
"MONGODB_DB": "test",
"MONGODB_URI": "mongodb+srv://db-user:mnj0pYRuglcOKvl5@cluster0.wdgepgr.mongodb.net/?retryWrites=true&w=majority"
}
```

#### Database
Docker service file with mongodb can be find here: [mongodb.yml](https://github.com/michmzr/PocketStats/blob/master/src/main/docker/mongodb.yml)



### Frontend
#### Environment variables
- `VUE_APP_BACKEND_URL` - java backend url

**You can read more in
article**: [https://cybershu.eu/articles/pocket-stats-analytics-app-get-pocket-api.html](https://cybershu.eu/articles/pocket-stats-analytics-app-get-pocket-api.html)
article**: [https://cybershu.eu/articles/pocket-stats-analytics-app-get-pocket-api.html](https://cybershu.eu/articles/pocket-stats-analytics-app-get-pocket-api.html) (it describes old version!)

0 comments on commit bd2352c

Please sign in to comment.