Skip to content

The SPLICE Catalog is a federated, metadata-driven platform for organizing and sharing educational resources in computer science education. Backed by the National Science Foundation (NSF) and developed in collaboration with six leading U.S. universities, SPLICE enables instructors, researchers, and learners to collaboratively upload, validate.

License

Notifications You must be signed in to change notification settings

babz007/splice-catalog

 
 

Repository files navigation

splice-catalog

Setup

cp env.example .env - contact a member of the SPLICE team for an updated environment file if you are interested in helping with development

Development

To build the catalog container: docker compose --profile catalog build

To install the node packages: docker compose --profile catalog run catalog yarn install

To start the splice catalog application: docker compose --profile catalog up

Once the container starts you'll want to

To exec into the running container: docker compose --profile catalog exec catalog bash (if you are on windows, you'll need to add winpty)

And run yarn migrate to instantiate the database

From inside this container, you can also run other yarn commands (install, add , etc)

Import Catalog Data

Once the application is running, upload any data files to http://localhost:3000/upload

Import Ontology Data

docker compose exec splice-catalog-catalog-1 yarn import:ontology

Interact with database

To access the database from the command line:

docker compose --profile catalog exec db bash
mysql -usplice -psplice
use splice;

See documentation here: docs

Production

docker compose --profile production build

docker compose --profile production up -d

About

The SPLICE Catalog is a federated, metadata-driven platform for organizing and sharing educational resources in computer science education. Backed by the National Science Foundation (NSF) and developed in collaboration with six leading U.S. universities, SPLICE enables instructors, researchers, and learners to collaboratively upload, validate.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 65.7%
  • EJS 24.4%
  • CSS 6.0%
  • JavaScript 2.9%
  • Other 1.0%