Skip to content

Latest commit

 

History

History
110 lines (96 loc) · 4.85 KB

README.md

File metadata and controls

110 lines (96 loc) · 4.85 KB
Raw

pace-admin

Publication Activity Collection Environment (PACE) Admin Tools and DB

A pilot project under development to investigate ways to streamline and improve the collection, reporting, and analysis of related publication information for the subsequent annual reporting process for campus centers and institutes. It is a time consuming process for each center/institute to determine scholarly productivity by polling faculty, reviewing their CVs, etc., where confidence in the data collected is crucial to ensure good investment decisions of University resources.

This pilot project will prototype a new process that automates data collection from internal and external sources and reporting, as well as integrate validation steps to increase confidence in data considered.

Starting from scratch

  1. Make sure you have Docker and Docker Compose.
  2. Also install the Hasura CLI. Run the following comme to ensure you have the correct version: 
    hasura update-cli --version v2.1.1
  3. If you are using a Mac with the M1 chip (AMR64) you will need to manually build Keycloak. Change to your root git directory on your machine and run the following commands" git clone https://github.com/keycloak/keycloak-containers.git cd keycloak-containers/server git checkout tags/15.1.1 -b 15.1.1 git fetch --all --tags docker build -t jboss/keycloak:15.1.1 .
  4. You may already have Node on your system but installing the recommended version via NVM or NVM Windows is preferred. Please install NVM.
  5. Clone the repository from Github
  6. Run the following to enter the pace-admin directory and initiate a new environment variable file by copying environment template: 
    cd pace-admin
cp .env.example .env
  7. Now would be the appropriate time to make changes to your .env file; we will provide documentation for the options in the near future.
  8. Now install and use the version of node as specified in ./.nvmrc by running the following from the above pace-admin directory: 
    nvm install
nvm use
  9. Install Yarn, Quasar CLI, and each applications node modules by running: 
    make install
  10. Run: 
    make setup
    When this is complete, copy the value of the public field into MEILI_PUBLIC_KEY of your .env file. For example, 
    {
  "public": "...",
  "private": "..."
}
  11. Run: 
    make newdb
  12. Open several termanals and run the following commands: 
    make docker && make logs
make client
make server
make migration-console
  13. Now open http://localhost:8000 (or whatever port you chose in your .env file) and login using the credentials in the following variables of the .env file: 
    [email protected]
DEV_USER_FIRST_NAME=Test
DEV_USER_LAST_NAME=Testersen
DEV_USER_PASSWORD=password

Running in production

  1. First, make sure ./.env includes ENV=prod. This not only configures your environment properly but adds several protections to commands invoked via make.
  2. Next, check the rest of the environment varialbes in ./.env. You'll certainly need to customize these settings.

Production - Harvest Data from Scopus

Production - Generate Thumbnails and harvest PDFs for publications

Production - Dashboard Data

When you get to a point where publications have been reviewed and approved for a center/institute you can load data into the dashboard by running

make dashboard-ingest

Updating your database

File tree summary (TODO)

FAQ (TODO)

What do I do about the following warning from redis? WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.

TODO

  • Deal with data.ms in dashboard-search (add to make clean, add .gitkeep, and add to .gitignore)
  • Run app through lighthouse
  • Add rest of notre dame metadata in the vue-head on the landing page
  • don't recomple spa every time on make prod