Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
- Remove outdated info and screenshot
- Link to the indexer README for more info
  • Loading branch information
thatbudakguy committed Sep 9, 2024
1 parent c1d9142 commit 4d47c41
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
# EarthWorks
[![CI](https://github.com/sul-dlss/earthworks/actions/workflows/ruby.yml/badge.svg)](https://github.com/sul-dlss/earthworks/actions/workflows/ruby.yml)

Geospatial discovery application for Stanford University Libraries, built using [GeoBlacklight](https://github.com/geoblacklight).
[![CI status](https://github.com/sul-dlss/earthworks/actions/workflows/ruby.yml/badge.svg)](https://github.com/sul-dlss/earthworks/actions/workflows/ruby.yml)

<img src="preview.png" align="center" alt="bay area video arcades slideshow preview">
Geospatial discovery application for Stanford University Libraries, built using [GeoBlacklight](https://github.com/geoblacklight).

## Developing

### Pre-requisites
* Ruby 3.1 or 3.2. **Other versions may work but are unsupported.**
For the currently supported Ruby version, see the `.github/workflows/ruby.yml` file.

### Installing

Pull down the code:

```sh
git clone [email protected]:sul-dlss/earthworks.git
```

#### Run the supporting services

You can do this by either running them directly on your dev machine, or by running them in containers using Docker (you should choose one or the other)

##### Running supporting services directly

Start an [Apache Solr](https://solr.apache.org/) instance using [solr_wrapper](https://github.com/cbeer/solr_wrapper):

```sh
solr_wrapper
```

##### Running supporting services using Docker

A more production-like setup using [Redis](https://redis.com/) and [Postgresql](https://www.postgresql.org/) is available via Docker. To start the stack:

```sh
docker compose up
```
Expand All @@ -41,13 +45,15 @@ The Solr connection info is the same regardless of whether it's run using solr_w
Alternatively, you could specify those env vars by prefixing the rails command with them, to (for example) run the app once using Postgres while generally defaulting to SQLite (e.g. `DATABASE_URL='postgresql://earthworks:earthworks@localhost/earthworks?pool=5' bin/rails server`).

#### Install the Ruby and Javascript dependencies, and prepare the database

Next, run the setup script:

```sh
bin/setup
```

### Run the application

Finally, start the development web server:

```sh
Expand All @@ -57,27 +63,27 @@ bin/dev
This will compile the SCSS stylesheets with live reloading in addition to running a rails server.

### Adding data

To add a small amount of test records to the Solr index, you can use the `seed` task:

```sh
bin/rake geoblacklight:solr:seed
bin/rake earthworks:fixtures
```
You can also fetch records from [OpenGeoMetadata](https://github.com/OpenGeoMetadata) using [GeoCombine](https://github.com/OpenGeoMetadata/GeoCombine):

To index arbitary data from SDR, see the [searchworks_traject_indexer README](https://github.com/sul-dlss/searchworks_traject_indexer/blob/main/README.md).

You can also fetch non-Stanford records from [OpenGeoMetadata](https://github.com/OpenGeoMetadata) using [GeoCombine](https://github.com/OpenGeoMetadata/GeoCombine):

```sh
export OGM_PATH=tmp/opengeometadata # location to store data
bin/rake geocombine:clone[edu.nyu] # pull data from NYU
bin/rake geocombine:index # index data in Solr
```
At Stanford, geospatial data is transformed and indexed by the [gis-robot-suite](https://github.com/sul-dlss/gis-robot-suite).

## Testing

You can run the full suite of tests with the `ci` command. **Do not** run this while ssh tunneled as it may delete the production index!

```sh
bin/rake ci
```

There is also a separate suite of "data integration" tests, which are intended to be run against a production search index.
```sh
export TEST_SOLR_URL=http://example.com:8080/solr/core_name
bin/rake integration
```

0 comments on commit 4d47c41

Please sign in to comment.