Skip to content

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

49 Commits

Folders and files

Repository files navigation

PCDS Library logo

PCDS Library

A digital library and circulation system for Philippine Christian Discipleship School (PCDS).

Visit the Live Library Portal →

PCDS Library brings book discovery, borrowing, and library operations together in one system. Students and teachers can browse the collection and keep track of their requests and loans, while library staff can manage books, circulation, borrowers, and reports.

Screenshots

Borrower dashboard

Students and teachers can review their account status, current loans, pending requests, overdue books, and notifications.

PCDS Library borrower dashboard

Library staff dashboard

Library staff can see an overview of the collection, requests, loans, overdue books, penalties, and borrower activity.

PCDS Library staff dashboard

Features

  • Book catalog: Browse and search books by title, author, ISBN, and library identifiers.
  • Borrowing workflow: Submit borrowing requests and follow their status.
  • Loan tracking: Review active loans, due dates, overdue items, and borrowing history.
  • Library operations: Manage books, requests, returns, borrowers, notifications, and library settings.
  • Account and access management: Support for student, teacher, librarian, and administrator roles, with profile verification and role-based access.
  • Monitoring and reports: View library summaries, penalties, and audit logs.
  • Web and desktop clients: Use the React web application or the Windows desktop application for library staff.

Technology

Area Technologies
Web frontend React, Vite, React Router
API Python, Flask, Flask-JWT-Extended
Database MySQL, SQLAlchemy, Flask-Migrate
Desktop application C#, WPF, .NET 10

Run locally

Requirements

  • Python 3.10 or later
  • Node.js and npm
  • MySQL
  • Windows and the .NET 10 SDK to build the desktop application

1. Configure the backend

Create a MySQL database, then configure the backend environment:

cd backend
py -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
Copy-Item .env.example .env

Update backend/.env with your local MySQL connection string and the required application settings. Configure Google OAuth and email settings if you want to use those features. Keep .env private; do not commit credentials or secrets.

Apply database migrations and start the API:

python -m flask --app run db upgrade
py run.py

The API runs with Flask's development server. For deployment, use a production WSGI server and configure the environment and database for your hosting platform.

Run the email notification job once per day from your deployment scheduler to send due-date reminders, overdue notices, and the library requests/penalties summary:

python -m flask --app run send-daily-emails

The job is idempotent per day: already-sent reminders and summaries are recorded in the audit log and are not sent again that day.

Railway's mysql.railway.internal hostname is private and cannot be reached from a local PC. For a local run, set LOCAL_DATABASE_URL to a local MySQL database, or copy Railway's public TCP proxy URL into MYSQL_PUBLIC_URL (or DATABASE_PUBLIC_URL). When the command runs inside Railway, it continues to use DATABASE_URL and the private network automatically.

Persistent uploaded images on Railway

Book covers must live on a Railway Volume so they survive deployments and restarts. Attach one Volume to the backend service and use /data as its mount path. Railway supplies RAILWAY_VOLUME_MOUNT_PATH automatically; the backend then stores book covers below /data/uploads/book_covers without requiring an additional variable.

2. Run the web frontend

In a second terminal:

cd frontend
npm install
npm run dev

Open the local URL printed by Vite, usually http://localhost:5173.

3. Build the Windows desktop application

From the repository root:

dotnet build .\PCDSLibrary.Desktop\PCDSLibrary.Desktop\PCDSLibrary.Desktop.csproj

Desktop installer

Windows users can download the latest PCDS Library Desktop installer from the GitHub Releases page. The published x64 installer is self-contained and does not require a separate .NET runtime installation.

Repository layout

backend/                 Flask API, database models, routes, and migrations
frontend/                React web application
PCDSLibrary.Desktop/     Windows WPF desktop application and installer
docs/screenshots/        Project screenshots used in this README

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages