Initial setup instructions and cleanup #78
Conversation
There was a problem hiding this comment.
I ran through the Getting Started section several times on my Macbook Air trying to see where a new person would get tripped up. I have a lot more suggestions but for the immediate need, let's call it good to go and move on. I can make a PR for other changes later.
Please correct the requirements.txt before merging this PR because it could be a blocker for a new person.
The suggestions for the README and upia_org/settings/base.py can be ignored.
There was a problem hiding this comment.
Suggestions:
- It may be better to put the Getting Started section in a separate document so that this page isn't too long to read. Replace it in the README with a link called Getting Started for Developers. The document could be called Developers because it is for people wanting to run the website locally or help make changes. May be developers isn't the best term to use.
- Put the Frontend section before the Backend because the next step would be to visit the home page of the website that the backend is serving. The frontend can be started up before the backend.
- There should be some short explanation of what the frontend providing, why it is needed, and how a developer would make changes to the frontend portion. For deployment, would the frontend be needed? I guess that should be covered in a Deployment document.
- Later, it might be clearer to separate the steps that are done as initial setup from the step that runs the frontend and the backend servers in their respective sections. The current wording tries to help with these two different situations.
There was a problem hiding this comment.
Yeah, I think this indicates we should do another run at cleaning up the Wiki - maybe just adding another page to the Wiki with the entire "Getting Started" section
|
I forgot to mention that the drop-down menu for Hello doesn't work when you visit the home page at http://localhost:8000/ or http://127.0.0.1:8000/. Interestingly, the font size is different between what the two URLs render. |
Description
This PR contains an initial working UIPA.org froide theme, along with instructions contained in the README to get it working.
Some things have been deleted that we will eventually need to place back (i.e. a Test and a Prod environment settings file). Other things have been left in a disintegrated state (many
uipa_org.themePython modules), however this at least will provide a working baseline for future development.Much of this PR (requirements.txt versions and
settings/folder structure) were taken from https://github.com/okfde/fragdenstaat_de/tree/main/fragdenstaat_de. For things that were removed from the codebase in this PR, they can still be referenced in themasterbranch in this repository.Related Items
Relevant Issue: #50