From ee7365e70aded4893ac2e4775f8269be96c83c69 Mon Sep 17 00:00:00 2001 From: Kevin Rocker Date: Sat, 15 Nov 2025 15:07:51 +0100 Subject: [PATCH 1/2] Update Readme with all setup instructions --- README.md | 34 ++++++++++++++++++++++++++++++++++ README.rst | 12 ------------ 2 files changed, 34 insertions(+), 12 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..28da500 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# The United States PostgreSQL Association website + +These are the PgUS templates which override the PgEU templates. + +## Installation + +### Setting up PgEU + +* Clone the [PgUS fork](https://github.com/pg-us/pgeu-system) of the PgEU codebase. + * This fork is the same as the base system, but with devcontainers for Podman/VSCode +* Start the dev container with whatever you'd prefer. This has mostly been tested in VSCode. +* Run `./install.sh` from within the dev container to configure the super user, the local settings, etc. +* Run `python3 manage.py runserver` to start the server. You should see unskinned pages at this point. + +### Applying Our Skin + +* Clone this repository in a folder *next to the pgeu-system*. + * The pgeu dev container has access to all peer directories of `pgeu-system` to enable skins. +* Add `SYSTEM_SKIN_DIRECTORY = "/workspaces/pgusweb"` to `local_settings.py` +* Non-HTML assets will need to be symlinked with `ln -s pgusweb/media/pgus pgeu-system/media`... +* ...and then excluded from PgEU's git with `echo 'media/pgus' > .git/info/exclude` + +## Future Setup Improvements + +Relying on Dev Containers is not ideal for non-VSCode users, we should migrate to basic Docker tooling. + +The _ideal_ docker setup would also use the `uwsgi` server instead of the Django server. This should remove the need to symlink the PgUS assets. + +## License + +The code for the website is licensed under `The PostgreSQL Licence +`_, which is closely related to +the BSD license. + diff --git a/README.rst b/README.rst deleted file mode 100644 index 63e657b..0000000 --- a/README.rst +++ /dev/null @@ -1,12 +0,0 @@ -The United States PostgreSQL Association website -================================================ - -These are the PgUS templates which override the PgEU templates. - -License -------- - -The code for the website is licensed under `The PostgreSQL Licence -`_, which is closely related to -the BSD license. - From 94795569efc4bee6bfb4234e244332590c3b6941 Mon Sep 17 00:00:00 2001 From: Kevin Rocker Date: Sat, 15 Nov 2025 15:09:42 +0100 Subject: [PATCH 2/2] Add environment info --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 28da500..f2cec07 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,18 @@ These are the PgUS templates which override the PgEU templates. * Non-HTML assets will need to be symlinked with `ln -s pgusweb/media/pgus pgeu-system/media`... * ...and then excluded from PgEU's git with `echo 'media/pgus' > .git/info/exclude` -## Future Setup Improvements +### Future Setup Improvements Relying on Dev Containers is not ideal for non-VSCode users, we should migrate to basic Docker tooling. The _ideal_ docker setup would also use the `uwsgi` server instead of the Django server. This should remove the need to symlink the PgUS assets. +## Environments + +The production website is deployed from `master`. + +The test website is deployed from `test`. Ask any existing member for the test site username/password. + ## License The code for the website is licensed under `The PostgreSQL Licence