pwbriggs / library

Open-source software for cataloging and loaning items in a library.

Library

Open-source software for cataloging and loaning items in a library.

If you have feature requests or suggestions, don't hesitate to open an issue!

Git Branches

The stable branch is always ready to deploy, with minimal bugs. In the future, the beta branch will be as well, but currently beta is not safe for public-facing deployment — it may give unauthenticated + unmoderated access to the database, so that we can test the code before implementing actual application logic.

library's Issues

🚀 Initial development

This is a new project. Here's some development work that needs to be done to meet the baseline requirements for the app:

• #9
• #70
• User creation & management
• Login
• View & manage catalog
• Check in & out
• Dashboard
• And more...

ESLint Flat Config

Upgrade to eslint 9, which needs us to migrate to an eslint "flat config" file.

Add auth

Implement authorization and user creation.

Libraries are different from many other systems in that accounts cannot be created by just anybody. A librarian (or admin) needs to create user accounts for the patrons. Likewise, an admin creates librarian accounts (or rather, elevates the permissions of a patron).

But then where do admins come from?

My best idea so far is to have some config (.env file?) with an initial admin password. Somewhere on the site (probably root route or login page) we do the following:

• If no admin accounts exist (or perhaps no accounts at all? there's pros and cons to each), show message to the effect of "This server isn't configured properly. Please contact your library. If you are the operator of this server, please add a SETUP_PASSWORD entry to the config file."
• If no admin accounts exist and the initial password is configured, create a new admin account.
• If an admin account does exist and the initial password is configured, give a warning similar to the one above, saying to remove the file. This is for security reasons (we don't want a situation where an account is being auto-created accidentally).

Problem is, the vast majority of the time will be the happy path, so how do we avoid unnecessary requests? Can we run the database query only on server startup?

It would be nice if this could just be prompted on server startup. However, some setups might not allow interaction with the command line of the deployment machine.

ESLint + Playwright integration

Consider integrating Playwright and ESLint, maybe with something like eslint-plugin-playwright.

Add database & Prisma

Set up Prisma and a database schema. Also add scripts to set up a PostgreSQL database for use in development.

Fix build preview command

pnpm start doesn't seem to be working since Vite migration (but I haven't done any real checks on that yet).

Vite migration

Migrate from Remix Classic compiler to Vite.