Skip to content
oss-sluPublic

About

UC Santa Cruz' open source repository browser scaled for the web

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Open Source Repository Browser

  • Building a modern web architecture around the work originally done by the UC OSPO Network

Tech stack:

  • Frontend

    /app

    • Typescript
    • React
    • Vite
    • Nginx
  • Backend

    /api

    • Typescript
    • NodeJS
    • Express

Project installation/setup

1. Download and install Docker Desktop

2. Clone the repository & open project locally

git clone https://github.com/oss-slu/oss-orb.git
cd oss-orb

3. Run project with Docker compose

The frontend can be served by nginx via the app container (production behavior) or with vite's dev server for developers to take advantage of hot reloading.

  • Use docker frontend:

    • Start frontend and backend containers:
      docker compose up --build -d
    • Frontend should now be accessible in your browser via Nginx at http://localhost:8087
  • Run frontend via vite development server:

    • First, ensure Node JS is installed
    • Run backend container:
      docker compose up api --build -d
    • Run vite dev server:
      cd app && npm ci && npm run dev
    • Frontend should now be accessible in your browser via Vite at http://localhost:6284

4. Optionally, download the UC OSPO Network Parquet file locally:

About

UC Santa Cruz' open source repository browser scaled for the web

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages