Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-chamberlain authored Jun 10, 2024
1 parent 95c610d commit f55d3ce
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ An API and UI for searching, using, and maintaining Data Sources.
#### [Live app](https://data-sources.pdap.io/)
#### [API docs](https://docs.pdap.io/api/introduction)

## Installation
## Running the app for local development

### 1. Clone this repository and navigate to the root directory.

Expand Down Expand Up @@ -50,24 +50,30 @@ pip install -r requirements.txt

### 5. Add environment secrets

Either add a `.env` file to your local root directory or manually export these secrets: `DO_DATABASE_URL` and `VITE_VUE_API_BASE_URL`.

Reach out to [email protected] or make noise in Discord if you'd like access to these keys.
Either add a `.env` file to your local root directory or manually export these secrets. Reach out to [email protected] or make noise in Discord if you'd like access.

#### Sample `.env` file
```
# .env
# Local development
VITE_VUE_API_BASE_URL='http://localhost:5000'
VITE_VUE_APP_BASE_URL='http://localhost:8888'
# Deployed app
# VITE_VUE_API_BASE_URL='https://data-sources.pdap.io/api'
# VITE_VUE_APP_BASE_URL='https://data-sources.pdap.io/'
# Production database and API
DO_DATABASE_URL='secret'
SECRET_KEY='secret'
DO_DATABASE_URL="postgres://data_sources_app:<password>@db-postgresql-nyc3-38355-do-user-8463429-0.c.db.ondigitalocean.com:25060/defaultdb"
VITE_VUE_API_BASE_URL="http://localhost:5000"
VITE_VUE_APP_BASE_URL="http://localhost:8888"
# Mailgun key for notifications
MAILGUN_KEY='secret'
```

```
# shell
export DO_DATABASE_URL=postgres://data_sources_app:<password>@db-postgresql-nyc3-38355-do-user-8463429-0.c.db.ondigitalocean.com:25060/defaultdb
export VITE_VUE_API_BASE_URL="http://localhost:5000"
export VITE_VUE_APP_BASE_URL="http://localhost:8888"
```

### 6. Allow your IP address
Expand Down

0 comments on commit f55d3ce

Please sign in to comment.