https://github.com/tulibraries/funnel_cake
Blacklight application for viewing and searching PA Digital aggregated metadata
https://github.com/tulibraries/funnel_cake
blacklight dpla
Last synced: 5 months ago
JSON representation
Blacklight application for viewing and searching PA Digital aggregated metadata
- Host: GitHub
- URL: https://github.com/tulibraries/funnel_cake
- Owner: tulibraries
- Created: 2019-03-13T20:25:35.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2026-01-28T16:37:03.000Z (5 months ago)
- Last Synced: 2026-01-29T07:23:55.694Z (5 months ago)
- Topics: blacklight, dpla
- Language: CSS
- Homepage:
- Size: 1.44 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Funnel Cake
---------
[Funnel Cake](https://funnelcake.padigital.org/) is an internal site to search and view PA Digital aggregated metadata for quality assessment. It is built with [Blacklight](https://projectblacklight.org/). Funnel Cake also serves as the development and production endpoint for PA Digital's OAI-PMH feed.
For more information, see [About the PA Digital Aggregator](https://padigital.org/about-aggregator/).
## System requirements
- Ruby 3.3.0
Getting set up for local development
---------
TODO
### Setting up Postgres on your local machine
You'll need a running Postgres >= 9.5 on your local dev machine.
#### Installing on OSX
Install with homebrew
```bash
brew install postgres
```
Next, set up postgres to run as a service
```bash
brew services start postgres
```
#### Installing on Ubuntu
Install with postgres and development library via apt
```bash
sudo apt-get install postgresql-server libpq-dev
```
`apt-get` should set up postgres as a service.
#### Create a postgres user
Finally, we need to create a postgres role with enough privileges to create and destroy databases. We'll use the built in `createuser` command with the `-d` flag that allows the user to create and destroy databases, and the `-W` flag that will cause the command to prompt your for a password, which is just `password`.
##### OSX
```bash
$ createuser -dW funnelcake
Password: #now enter your password
```
##### Ubuntu
On ubunutu, we need to run commands as the postgres users
```bash
$ sudo su -c "createuser -dW funnelcake" postgres
Password: #now enter your password
```
### Set up development environment
#### Point the envirnoment to the desired Solr server
```
$ export SOLR_IP=":@
$ cp .env-dev .env
```
#### Install gem dependencies
```
$ bundle install
```
#### Migrate databases
```
$ rails db:migrate
```
#### Start the Funnelcake Application Server
```
$ bundle exec rails server, or bin/dev to watch for and recompile ccs changes
```
#### To start up a local instance of solr cloud
```
$ cd ..
$ git clone https://github.com/tulibraries/ansible-playbook-solrcloud.git
$ cd ansible-playbook-solrcloud
$ make up-lite
```
Set the SOLR_IP address before starting the Funnelcake server
```
export SOLR_IP="127.0.0.1:8090"
```
NOTE: The Funnelcake Solr repository should be seeded for the application to function properly