CMS/cmsmanage
2
0
Fork 0
Code Issues 8 Pull Requests 3 Actions Projects 1 Releases Activity
A management site for the Claremont MakerSpace https://manage.claremontmakerspace.org/
517 Commits 4 Branches 0 Tags 6.5 MiB
Python 85.9%
HTML 12.1%
TypeScript 1%
CSS 0.7%
JavaScript 0.3%
2d2f0a360b
Go to file
Renovate Bot 2d2f0a360b
All checks were successful
Ruff / ruff (push) Successful in 1m13s
Details
Ruff / ruff (pull_request) Successful in 45s
Details
Test / test (pull_request) Successful in 9m32s
Details
Test / test (push) Successful in 9m14s
Details
chore(deps): update dependency vite to v5.4.2
2024-08-20 14:31:13 +00:00
.gitea/workflows CI: Pin MariaDB version to avoid recently introduced bug 2024-08-16 00:22:37 -04:00
cmsmanage CI: Build Vite assets for test workflow 2024-08-16 00:22:32 -04:00
dashboard Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
doorcontrol doorcontrol: Simplify querystring handling using new querystring tag 2024-08-17 00:26:22 -04:00
js membershipworks: Fix missing bootstrap CSS in invoice PDFs 2024-07-24 21:53:44 -04:00
membershipworks membershipworks: Add basic tests for validity of Event financial queries 2024-08-15 23:56:03 -04:00
paperwork Apply Ruff's flake8-type-checking (TCH) rules 2024-08-09 01:47:32 -04:00
rentals Improve various admin pages performance using select/prefetch related 2024-08-09 01:47:32 -04:00
reservations Apply Ruff's flake8-type-checking (TCH) rules 2024-08-09 01:47:32 -04:00
static Add/apply prettier 2024-07-23 00:45:27 -04:00
tasks Apply Ruff's flake8-no-pep420 (INP) rules 2024-08-09 01:47:32 -04:00
templates Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
.gitignore Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
.pre-commit-config.yaml Bump dependencies 2024-08-16 17:56:57 -04:00
.prettierignore Add/apply prettier 2024-07-23 00:45:27 -04:00
.prettierrc Add/apply prettier 2024-07-23 00:45:27 -04:00
manage.py Convert settings to use django-configurations 2024-05-03 12:37:48 -04:00
package.json Bump dependencies 2024-08-16 17:56:57 -04:00
pdm.lock Bump dependencies 2024-08-16 17:56:57 -04:00
pdm.toml Use compatible version save strategy in PDM 2023-06-21 14:09:00 -04:00
pnpm-lock.yaml chore(deps): update dependency vite to v5.4.2 2024-08-20 14:31:13 +00:00
pyproject.toml Bump dependencies 2024-08-16 17:56:57 -04:00
README.md Update the development notes in the README 2024-07-23 00:45:27 -04:00
renovate.json Add/apply prettier 2024-07-23 00:45:27 -04:00
tsconfig.json Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
vite.config.js membershipworks: Fix missing bootstrap CSS in invoice PDFs 2024-07-24 21:53:44 -04:00

README.md

CMS Management

A management site for the Claremont MakerSpace

Development

This assumes a relatively recent Linux system. It should work fine on MacOS, and might work on Windows.

Python Setup

  1. Get Python 3.11 and PDM
  2. Run pdm install
  3. Create settings.dev.env with config as required by ./cmsmanage/settings.py
  4. Run pdm run ./manage.py migrate to create database tables
    • At present, this will require an annoying amount of manual fiddling to create the JSON_TABLE views (due to MariaDB bugs) unless you run this as the root user for the database.
  5. (Optional) If you have access to the production server, you can use real data:
    1. pdm run ./manage.py dumpdata -o whatever.json (on the server)
    2. pdm run ./manage.py loaddata whatever.json (on your machine)
  6. Run pdm run ./manage.py createsuperuser to make a user

JavaScript setup

  1. Install NodeJS and pnpm
  2. Run pnpm install

Running the dev server

  • If you don't intend to work on the JavaScript code:
    • pnpm run build to build the JS/CSS
    • pdm run ./manage.py runserver to start the Django server
  • Otherwise:
    • pnpm run dev to start the Vite dev server
    • DJANGO_VITE_DEV_MODE=true pdm run ./manage.py runserver to start the Django server