https://github.com/ucl-arc/museum_of_dreams
Repository for the Museum of Dreamworlds Project
https://github.com/ucl-arc/museum_of_dreams
cinema classics collaborations film webapp website
Last synced: 6 months ago
JSON representation
Repository for the Museum of Dreamworlds Project
- Host: GitHub
- URL: https://github.com/ucl-arc/museum_of_dreams
- Owner: UCL-ARC
- Created: 2023-11-02T16:41:11.000Z (almost 2 years ago)
- Default Branch: development
- Last Pushed: 2025-04-24T19:56:59.000Z (6 months ago)
- Last Synced: 2025-04-24T20:43:15.228Z (6 months ago)
- Topics: cinema, classics, collaborations, film, webapp, website
- Language: JavaScript
- Homepage: https://museumofdreamworlds.org
- Size: 8.96 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Museum of Dreams Project - Website
   
The production website is hosted at http://museumofdreamworlds.eu-west-2.elasticbeanstalk.com/ and built from the `main` branch
The staging one is http://museumofdreams.eu-west-2.elasticbeanstalk.com/ and is built from the `development` branch
The offical versions are https://museumofdreamworlds.org and https://staging.museumofdreamworlds.org
Development 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.
## Getting Started
To 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).
```
python venv modvenv
source modvenv/bin/activate
pip install -r requirements-base.txt
python manage.py runserver
```
If it's your first time initialising the app on your machine, you may need to run migrations and create a superuser
```
python manage.py migrate
python manage.py createsuperuser
```
To populate the db with data, run
```
python manage.py loaddata path/to/dump/file
```
### AWS
This 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.
You 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.
### Running tests
Running tests is not advised on AWS as you should only push to the respective branches when you've finished testing locally.
To run the tests locally, run
```
python manage.py test mod_app/tests
```
### Troubleshooting
If you get a CI precommit error, try running
```
pre-commit run --all
```
If you're getting any errors related to static files, try running
```
python manage.py collectstatic --noinput
```
### Technologies used
This project uses a number of technologies, including:
- [Django 4.2](https://docs.djangoproject.com/en/4.2/)
- [OpenProps](https://open-props.style/#colors) (CSS variable package)
- [CK Editor 4](https://ckeditor.com/docs/ckeditor4/latest/index.html)
- [Fuse.js](https://www.fusejs.io/)
- [AWS](aws.com)
Others which have tangentially helped with development:
- Hypothesis
- Figma
---
### See these other files for recreating the AWS setup and other features.
#### [Setting up from scratch](docs/howtoSetupBase.md) This covers how you'd go about recreating the AWS setup from scratch
#### [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
#### [How to set up the AWS chatbot for notifications](docs/AWSchatbot.md)
#### [Using S3 for staticfiles](docs/s3ForStatic.md)
#### [Setting up email notifications](docs/AWSses.md)