A management site for the Claremont MakerSpace https://manage.claremontmakerspace.org/
Go to file
Adam Goldsmith 617b469d85 Generate PDM lock file only for CMS-www environment
This allows newer versions of some dependencies, as well as faster installs
2024-08-09 01:47:32 -04:00
.gitea/workflows Add/apply prettier 2024-07-23 00:45:27 -04:00
cmsmanage Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
dashboard Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
doorcontrol doorcontrol: Grant instructors access for ~1 hour around their class times 2024-06-07 09:42:40 -04:00
js membershipworks: Fix missing bootstrap CSS in invoice PDFs 2024-07-24 21:53:44 -04:00
membershipworks membershipworks: Fix script in upcoming events post generator 2024-08-09 01:47:07 -04:00
paperwork Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
rentals Apply ruff lint rule DJ012 for model internals ordering 2024-06-07 09:36:49 -04:00
static Add/apply prettier 2024-07-23 00:45:27 -04:00
tasks Apply ruff lint rule DJ012 for model internals ordering 2024-06-07 09:36:49 -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-07-18 10:40:28 -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 Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
pdm.lock Generate PDM lock file only for CMS-www environment 2024-08-09 01:47:32 -04:00
pdm.toml Use compatible version save strategy in PDM 2023-06-21 14:09:00 -04:00
pnpm-lock.yaml Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
pyproject.toml Bump dependencies 2024-07-23 00:45:27 -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

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