Welcome to Covers, a stampless cover and postmark catalog application
This build, nicknamed Lightspeed, is version 2.0.0
Another success is the post-office, with its educating energy augmented by cheapness and guarded by a certain religious sentiment in mankind; so that the power of a wafer or a drop of wax or gluten to guard a letter, as it flies over sea over land and comes to its address as if a battalion of artillery brought it, I look upon as a fine meter of civilization.
-- Ralph Waldo Emerson
Version strings follow the MAJOR(#?).MINOR(#?).REVISION(#?) format.
Current planned Milestones are alpha, beta, and rtm.
Currently only tested on Chromium (TODO: version?) on Windows 11, and Brave (1.82.170-arm64) on macOS Sequoia
For licensing details, see LICENSE
- Common Model
- TODO: DESCRIBE HERE
- WoCo Server
- TODO: DESCRIBE HERE
- Frontend (React)
- The public UI at hellowoco.app is a React SPA (e.g. from Lovable). Put the app in
frontend/, runnpm run build; Django serves it as the site home and all frontend routes. API and admin stay under/api/and/admin/.
- The public UI at hellowoco.app is a React SPA (e.g. from Lovable). Put the app in
For more details see DESIGN.md
This project uses pipenv, and django. Make sure you have at least python 3.11 installed.
dotenv is used as well, but strictly for convenience. It allows you to directly call django-admin for all project commands, instead of python manage.py.
For building other targets, and instructions for packaging in preparation for deployment, see BUILD.md.
To have the site home and routes served by the React app (e.g. at hellowoco.app), add your frontend in frontend/ and run npm run build there before deployment. The built output (frontend/dist/) is not in git, so your deploy must run the frontend build (e.g. cd frontend && npm ci && npm run build) before starting Django. See docs/DEPLOY.md and frontend/README.md.
To run Covers in Production mode, execute the following:
./TODOTo run both the backend and frontend in debug mode, execute the following instead:
./TODOFor information on how to run the separate sub-projects, and perform administrative actions post-deployment, see RUNBOOK.md
TODO: Links to repo wiki
TODO: Links to user documentation
TODO: Links to developer/contributor documentation
Of course, make sure you also visit our sponsor The US Philatelic Classics Society, and see our live version of this app!
For any issues or contributions to Covers, please refer to our issue tracker or contributing guide.
Parts of this codebase were generated by AI. No PRs are automatically accepted without human review, and a good faith effort is being made to avoid leaked proprietary code and usage without attribution. Do not hesitate to contact us with questions/comments/concerns!
We hope you enjoy Covers!