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/
480 Commits 5 Branches 0 Tags 6.2 MiB
Python 85.9%
HTML 12.1%
TypeScript 1%
CSS 0.7%
JavaScript 0.3%
e006a6eb50
Go to file
Adam Goldsmith e006a6eb50 Update the development notes in the README
2024-07-23 00:45:27 -04:00
.gitea/workflows Convert settings to use django-configurations 2024-05-03 12:37:48 -04:00
cmsmanage Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
dashboard Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
doorcontrol doorcontrol: Grant instructors access for ~1 hour around their class times 2024-06-07 09:42:40 -04:00
js Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
membershipworks membershipworks: Simplify WordPress post generator clipboard JS 2024-07-19 00:11:28 -04:00
paperwork Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
rentals Apply ruff lint rule DJ012 for model internals ordering 2024-06-07 09:36:49 -04:00
static Use django-vite for JS bundling 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 Use django-vite for JS bundling 2024-07-23 00:45:27 -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
manage.py Convert settings to use django-configurations 2024-05-03 12:37:48 -04:00
package.json Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
pdm.lock Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
pdm.toml Use compatible version save strategy in PDM 2023-06-21 14:09:00 -04:00
pnpm-lock.yaml Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
pyproject.toml Use django-vite for JS bundling 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 renovate.json 2023-11-19 04:20:05 +00:00
tsconfig.json Use django-vite for JS bundling 2024-07-23 00:45:27 -04:00
vite.config.js Use django-vite for JS bundling 2024-07-23 00:45:27 -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