UC ORB Showcase

Overview

The University of California Open Source Repository Browser Showcase (UC ORB Showcase) enhances the discovery and visibility of open source projects across the UC system, making it easier for researchers, students, and external collaborators to engage with relevant projects. By mapping and classifying open source efforts, it highlights the impact of contributions from UC campuses, increasing recognition and potential funding opportunities.

git clone https://github.com/UC-OSPO-Network/orb-showcase

Running the Application (Docker Compose)

1. Create Environment Files

   • Backend:
     • Create a file at backend/.env with:

       POSTGRES_DB_URL=postgresql://postgres:orb@orb-db:5432/sample
       

   • Frontend:
     • Create a file at frontend/.env with (example):

       NEXT_PUBLIC_API_URL=http://localhost:8000
       

2. Start All Services

   From the project root, run:

   docker-compose up --build 

   This will start the backend, frontend, and connect to your running Postgres Database (in .env)

   Tip: For subsequent runs (when no code or dependency changes are made), you can use:

   docker-compose up

   for faster startup.

3. Accessing the App

   • Frontend: http://localhost:3000
   • Backend API: http://localhost:8000

---

Notes

• Both backend and frontend require their own .env files for configuration. These are mounted into the containers automatically by Docker Compose.

---