CMS/cmsmanage
2
0
Fork 0
Code Issues 8 Pull Requests 4 Actions Projects 1 Releases Activity
A management site for the Claremont MakerSpace https://manage.claremontmakerspace.org/
544 Commits 5 Branches 0 Tags 6.2 MiB
Python 85.9%
HTML 12.1%
TypeScript 1%
CSS 0.7%
JavaScript 0.3%
8c424c7e49
Go to file
Adam Goldsmith 8c424c7e49 Add coverage dev dependency, with basic config
2024-09-07 11:19:48 -04:00
.gitea/workflows Convert from MariaDB to PostgreSQL 2024-08-29 21:45:56 -04:00
cmsmanage Add django-postgres-metrics 2024-08-30 11:49:21 -04:00
dashboard Automatically detect .entry.ts files as Vite entry points 2024-07-24 01:50:34 -04:00
doorcontrol doorcontrol: Convert HIDEvent.raw_card_number to TextField 2024-09-03 11:05:32 -04:00
js membershipworks: Fix missing bootstrap CSS in invoice PDFs 2024-07-24 21:53:44 -04:00
membershipworks membershipworks: Use bulk upsert when scraping transactions 2024-09-02 12:50:08 -04:00
paperwork Convert from MariaDB to PostgreSQL 2024-08-29 21:45:56 -04:00
rentals Improve various admin pages performance using select/prefetch related 2024-08-09 01:47:32 -04:00
reservations Convert from MariaDB to PostgreSQL 2024-08-29 21:45:56 -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 Add some more paths to .gitignore 2024-09-07 11:15:51 -04:00
.pre-commit-config.yaml Bump dependencies 2024-09-03 11:08:58 -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-09-03 11:08:58 -04:00
pdm.lock Add coverage dev dependency, with basic config 2024-09-07 11:19:48 -04:00
pdm.toml Use compatible version save strategy in PDM 2023-06-21 14:09:00 -04:00
pnpm-lock.yaml Bump dependencies 2024-09-03 11:08:58 -04:00
pyproject.toml Add coverage dev dependency, with basic config 2024-09-07 11:19:48 -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