{"id":48515299,"url":"https://github.com/ayomalbanneka/openshelf","last_synced_at":"2026-05-02T08:05:28.128Z","repository":{"id":349822790,"uuid":"1202097872","full_name":"ayomalbanneka/openshelf","owner":"ayomalbanneka","description":"A free, open-source global library for everyone.","archived":false,"fork":false,"pushed_at":"2026-04-07T17:15:56.000Z","size":172,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-07T19:13:01.255Z","etag":null,"topics":["docker-compose","express-js","minio","nextjs","prisma-orm"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ayomalbanneka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-05T15:41:08.000Z","updated_at":"2026-04-07T17:14:46.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ayomalbanneka/openshelf","commit_stats":null,"previous_names":["ayomalbanneka/openshelf"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ayomalbanneka/openshelf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayomalbanneka%2Fopenshelf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayomalbanneka%2Fopenshelf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayomalbanneka%2Fopenshelf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayomalbanneka%2Fopenshelf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ayomalbanneka","download_url":"https://codeload.github.com/ayomalbanneka/openshelf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayomalbanneka%2Fopenshelf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31673358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T17:19:37.612Z","status":"online","status_checked_at":"2026-04-11T02:00:05.776Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-compose","express-js","minio","nextjs","prisma-orm"],"created_at":"2026-04-07T19:00:37.548Z","updated_at":"2026-04-11T08:13:35.447Z","avatar_url":"https://github.com/ayomalbanneka.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenShelf\n\nOpenShelf is a monorepo for a community-driven educational platform.\n\n- openshelf-web: Next.js frontend (App Router, TypeScript, Tailwind CSS)\n- openshelf-api: Express API with Prisma and PostgreSQL\n\n## Repository Structure\n\n```text\nOpenShelf/\n├─ openshelf-api/\n│  ├─ prisma/\n│  ├─ src/\n│  └─ package.json\n├─ openshelf-web/\n│  ├─ public/\n│  ├─ src/\n│  └─ package.json\n└─ README.md\n```\n\n## Tech Stack\n\n- Frontend: Next.js 16, React 19, TypeScript, Tailwind CSS 4\n- Backend: Node.js, Express 5, Prisma 7, PostgreSQL\n- Tooling: ESLint, Nodemon\n\n## Prerequisites\n\n- Node.js 20+\n- npm 10+\n- PostgreSQL 14+\n\n## Quick Start\n\n### 1. Install dependencies\n\n```bash\ncd openshelf-api\nnpm install\n\ncd ../openshelf-web\nnpm install\n```\n\n### 2. Configure environment variables\n\nCreate these files from examples:\n\n```powershell\nCopy-Item openshelf-api/.env.example openshelf-api/.env\nCopy-Item openshelf-web/.env.example openshelf-web/.env.local\n```\n\nmacOS/Linux alternative:\n\n```bash\ncp openshelf-api/.env.example openshelf-api/.env\ncp openshelf-web/.env.example openshelf-web/.env.local\n```\n\nUpdate openshelf-api/.env with your database connection:\n\n```env\nPORT=4000\nNODE_ENV=development\nCLIENT_URL=http://localhost:3000\nDATABASE_URL=postgresql://USER:PASSWORD@localhost:5432/openshelf\n```\n\nDefault frontend values (from openshelf-web/.env.example):\n\n```env\nNEXT_PUBLIC_API_URL=http://localhost:4000/api\nNEXT_PUBLIC_APP_NAME=OpenShelf\n```\n\n### 3. Prepare the database (Prisma)\n\n```bash\ncd openshelf-api\nnpx prisma generate\nnpx prisma migrate dev --name init\n```\n\n### 4. Run both apps\n\nRun in separate terminals.\n\nBackend:\n\n```bash\ncd openshelf-api\nnpm run dev\n```\n\nFrontend:\n\n```bash\ncd openshelf-web\nnpm run dev\n```\n\n### 5. Open the app\n\n- Frontend: http://localhost:3000\n- API health check: http://localhost:4000/health\n\n## Available Scripts\n\n### openshelf-api\n\n- npm run dev: Start API with nodemon\n- npm start: Start API in normal mode\n\n### openshelf-web\n\n- npm run dev: Start Next.js development server\n- npm run build: Build production bundle\n- npm start: Start production server\n- npm run lint: Run ESLint\n\n## Current API Endpoints\n\n- GET /health\n- GET /test-db\n\n## Troubleshooting\n\n- Prisma client errors:\n\t- Run npx prisma generate in openshelf-api.\n- Database connection issues:\n\t- Verify DATABASE_URL points to a running PostgreSQL instance.\n- CORS issues in local development:\n\t- Ensure openshelf-api/.env CLIENT_URL matches your frontend URL.\n\n## Notes\n\n- The API uses Prisma with the PostgreSQL adapter package @prisma/adapter-pg.\n- If you change the Prisma schema, run:\n\n```bash\ncd openshelf-api\nnpx prisma migrate dev --name your_migration_name\n```\n- For production deployment, set NODE_ENV=production and ensure environment variables are properly configured.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayomalbanneka%2Fopenshelf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayomalbanneka%2Fopenshelf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayomalbanneka%2Fopenshelf/lists"}