{"id":27870927,"url":"https://github.com/ucl-arc/museum_of_dreams","last_synced_at":"2025-05-04T23:28:38.369Z","repository":{"id":205796500,"uuid":"713502026","full_name":"UCL-ARC/museum_of_dreams","owner":"UCL-ARC","description":"Repository for the Museum of Dreamworlds Project","archived":false,"fork":false,"pushed_at":"2025-04-24T19:56:59.000Z","size":9398,"stargazers_count":1,"open_issues_count":22,"forks_count":0,"subscribers_count":2,"default_branch":"development","last_synced_at":"2025-04-24T20:43:15.228Z","etag":null,"topics":["cinema","classics","collaborations","film","webapp","website"],"latest_commit_sha":null,"homepage":"https://museumofdreamworlds.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UCL-ARC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-11-02T16:41:11.000Z","updated_at":"2025-04-15T12:43:48.000Z","dependencies_parsed_at":"2024-03-25T15:28:13.370Z","dependency_job_id":"401b53bc-90a8-45ad-9b71-2d6d780e9161","html_url":"https://github.com/UCL-ARC/museum_of_dreams","commit_stats":null,"previous_names":["ucl-arc/museum_of_dreams"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL-ARC%2Fmuseum_of_dreams","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL-ARC%2Fmuseum_of_dreams/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL-ARC%2Fmuseum_of_dreams/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UCL-ARC%2Fmuseum_of_dreams/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UCL-ARC","download_url":"https://codeload.github.com/UCL-ARC/museum_of_dreams/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252413556,"owners_count":21743924,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cinema","classics","collaborations","film","webapp","website"],"created_at":"2025-05-04T23:28:37.808Z","updated_at":"2025-05-04T23:28:38.357Z","avatar_url":"https://github.com/UCL-ARC.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Museum of Dreams Project - Website\n\n![Static Badge](https://img.shields.io/badge/built_with-Django_4.2-blue) ![Static Badge](https://img.shields.io/badge/OpenProps-1883e3) ![Static Badge](https://img.shields.io/badge/CKEditor4-8a2be2) ![Static Badge](https://img.shields.io/badge/hosted-232F3E?logo=amazonwebservices)\n\nThe production website is hosted at http://museumofdreamworlds.eu-west-2.elasticbeanstalk.com/ and built from the `main` branch\n\nThe staging one is http://museumofdreams.eu-west-2.elasticbeanstalk.com/ and is built from the `development` branch\n\nThe offical versions are https://museumofdreamworlds.org and https://staging.museumofdreamworlds.org\n\nDevelopment should be done locally and pushed to the staging website where researchers can test features and sign off on them before putting the code on production.\n\n## Getting Started\n\nTo work on this project as is, clone the repo into an appropriate folder (eg. `museum_of_dreams_project`). Create a venv at the top level and start it. Then install the requirements and launch the app. We use `requirements-base.txt` as AWS looks for `requirements.txt` and we don't need to install MySQL locally (we use a local sqlite db).\n\n```\npython venv modvenv\nsource modvenv/bin/activate\n\npip install -r requirements-base.txt\npython manage.py runserver\n```\n\nIf it's your first time initialising the app on your machine, you may need to run migrations and create a superuser\n\n```\npython manage.py migrate\npython manage.py createsuperuser\n```\n\nTo populate the db with data, run\n\n```\npython manage.py loaddata path/to/dump/file\n```\n\n### AWS\n\nThis project is hosted on AWS, if you do not have access to the account, let [Amanda Ho-Lyn](mailto:a.ho-lyn@ucl.ac.uk) know and she will arrange this.\nYou may find it beneficial to read through the [current AWS setup docs](docs/baseAWSSetup.md) to gain an understanding of the architecture of the project. Also have a look at the [development SOP](docs/developmentSOP.md) for an idea of the general development flow.\n\n### Running tests\n\nRunning tests is not advised on AWS as you should only push to the respective branches when you've finished testing locally.\nTo run the tests locally, run\n\n```\npython manage.py test mod_app/tests\n```\n\n### Troubleshooting\n\nIf you get a CI precommit error, try running\n\n```\npre-commit run --all\n```\n\nIf you're getting any errors related to static files, try running\n\n```\npython manage.py collectstatic --noinput\n```\n\n### Technologies used\n\nThis project uses a number of technologies, including:\n\n- [Django 4.2](https://docs.djangoproject.com/en/4.2/)\n- [OpenProps](https://open-props.style/#colors) (CSS variable package)\n- [CK Editor 4](https://ckeditor.com/docs/ckeditor4/latest/index.html)\n- [Fuse.js](https://www.fusejs.io/)\n- [AWS](aws.com)\n\nOthers which have tangentially helped with development:\n\n- Hypothesis\n- Figma\n\n---\n\n### See these other files for recreating the AWS setup and other features.\n\n#### [Setting up from scratch](docs/howtoSetupBase.md) This covers how you'd go about recreating the AWS setup from scratch\n\n#### [Current AWS Settings](docs/baseAWSSetup.md) This describes our current AWS settings without the processes of setting up, with a bit more explanation of why they are what they are\n\n#### [How to set up the AWS chatbot for notifications](docs/AWSchatbot.md)\n\n#### [Using S3 for staticfiles](docs/s3ForStatic.md)\n\n#### [Setting up email notifications](docs/AWSses.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucl-arc%2Fmuseum_of_dreams","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fucl-arc%2Fmuseum_of_dreams","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucl-arc%2Fmuseum_of_dreams/lists"}