Skip to content

Commit 4461ef1

Browse files
authored
Better dev (#10)
* enhancing dev experience - updated readme with docker dev instructions * bumping github upload action version
1 parent 98c0fd0 commit 4461ef1

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

.github/workflows/build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,10 @@ jobs:
105105

106106
- name: Upload artifacts
107107
if: ${{ always() }}
108-
uses: actions/upload-artifact@v3
108+
uses: actions/upload-artifact@v4
109109
with:
110110
name: artifacts
111-
path: /opt/app/artifacts/**
111+
path: artifacts/**
112112

113113
# TODO: DRY w/release.yml
114114
push:

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,3 +214,23 @@ above, and retags it with:
214214
Deployment is triggered manually via the `ops/docker-swarm` Jenkins build. The
215215
staging and production Docker stacks are configured to pull the `main` and `latest`
216216
images, respectively.
217+
218+
### Docker Development
219+
220+
For development purposes, the application can be run locally via Docker Compose.
221+
222+
Run:
223+
224+
```bash
225+
docker-compose up --build -d
226+
docker compose exec app rails db:create
227+
docker compose exec app rails db:migrate
228+
```
229+
230+
This will load some sample data into the database. You will then need to run the galc-ui application (from the [`galc-ui`](/BerkeleyLibrary/galc-ui) repository) in order to test the API.
231+
232+
If, instead, you want to create the database and not load the sample data, you can run...
233+
```bash
234+
docker-compose up --build -d
235+
docker compose exec app rails db:setup
236+
```

0 commit comments

Comments
 (0)