A full-featured 3D Print Job Management Platform for Public Libraries

MAKEatTADL is a web application developed by Traverse Area District Library (TADL) for managing 3D print requests from patrons and staff. The platform streamlines communication, estimation, and fulfillment of 3D printing jobs, designed for real-world use in public libraries.

• Features
• Screenshots
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
  • Development
• Usage
  • Submitting a Print Job
  • Staff Workflow
  • Admin Panel
• Architecture
• Deployment
• Contributing
• License
• Credits

• 🖨️ Patron Print Requests – Simple form for library patrons to submit 3D print jobs, including file uploads (STL, OBJ, ZIP).
• 🗨️ Conversation Thread – Messaging system for patron/staff communication per job.
• 🏷️ Status Tracking – Granular status management: pending, information requested, response received, approved, in progress, ready for pickup, cancelled... Statuses are a model, you can add more as needed.
• 💰 Cost Estimation – Staff can provide filament/cost/time estimates and request patron approval.
• 🏢 Admin UI – RailsAdmin-based staff portal full oversight, configuration, user/staff management.
• 📨 Email Notifications – Automated notifications for key status changes and messages.
• 🔒 Google OAuth – Secure staff login via Google Workspace SSO.
• 🗄️ File Storage – All print files handled by ActiveStorage, configurable for local or S3.
• ✨ Accessible UI – Simple, mobile-friendly design for patrons and staff.

(Add actual screenshots here when available)

• Ruby: 3.2.8 (use rbenv or asdf)
• Rails: 7.1.3.3
• PostgreSQL: 13+
• Redis: For Sidekiq jobs/queues
• Node.js & Yarn: For JS dependencies
• ImageMagick: For image processing (used by ActiveStorage)
• libvips: (optional, for faster image handling)

• Docker
• dotenv (for .env support)

Clone the repo:

git clone https://github.com/tadl/MAKEatTADL.git
cd MAKEatTADL

Install Ruby gems and JS dependencies:

bundle install
yarn install

Set up the database:

bin/rails db:setup

Environment Variables

Copy .env.example to .env and fill in the following at minimum:

GOOGLE_CLIENT_ID=your-google-oauth-client-id
GOOGLE_CLIENT_SECRET=your-google-oauth-client-secret
DEFAULT_ADMIN_EMAIL=[email protected]
DEFAULT_ADMIN_PASSWORD=changeme
MAILGUN_DOMAIN=your.mailgun.domain
MAILGUN_API_KEY=your-mailgun-api-key
RAILS_MASTER_KEY=your-master-key
SECRET_KEY_BASE=your-secret-key

Google OAuth Setup

• Go to Google Cloud Console.
• Create OAuth2 Credentials.
• Set authorized redirect URI to:
  https://<your-domain>/users/auth/google_oauth2/callback
• Fill in GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET in your .env.

Mail Configuration

• Outbound email is used for notifications.
• Fill in Mailgun API credentials in .env.

ActiveStorage

• Default: local storage (storage/ dir)
• For S3, update config/storage.yml and set STORAGE_SERVICE=amazon.

• Start the Rails server:
  bin/rails server

Visit http://localhost:3000 to get started.

1. Patron fills out the print job request form, uploads 3D model.
2. Staff are notified and review the submission.
3. Staff can communicate with patron via job message thread for clarification or updates.
4. Staff estimate cost/time/materials and request approval.
5. Patron approves/rejects; job moves to next stage.
6. Staff assign job to printer, set status, and track progress.
7. When job is done, staff mark as ready; patron is notified for pickup.

• Log in via Google SSO.
• View, filter, and manage all jobs.
• Use the RailsAdmin panel for advanced management.
• Communicate with patrons via messages.
• Track metrics and status of all jobs.
• Download and prepare print files.

• Available at /admin.
• Requires staff login.
• Manage users, jobs, printers, statuses, and more.
• All models manageable via RailsAdmin UI.

• Rails 7 app, modular design.
• ActiveStorage for all file uploads (optionally S3).
• OmniAuth for Google OAuth2 staff authentication.
• RailsAdmin for administrative interface.
• PostgreSQL database.

Directory layout:

app/
  controllers/
  models/
  views/
  jobs/
  mailers/
  services/
  ...
config/
db/
spec/
docs/

• Supports standard Heroku/Dokku-style deployment (git push dokku ...)
• Run database migrations after deploy:
  bin/rails db:migrate
• For persistent storage with Docker, map storage/ to a volume or use S3.

Environment Checklist:

• All required env vars set
• DB running and linked
• Storage configured
• OAuth and Mailgun (or SMTP) set

1. Fork the repo and clone your fork.
2. Create a feature branch: git checkout -b my-feature
3. Run tests and ensure code passes linter.
4. Open a pull request with a detailed description.

PRs are welcome! Please read CONTRIBUTING.md if available.

MIT

• Developed by Traverse Area District Library Technology Team
• Built with Ruby on Rails
• ChatGPT was used to assist with development.

This project is community-driven and open to other libraries!