{"id":15180354,"url":"https://github.com/mrmaxguns/dream-journal","last_synced_at":"2025-10-26T19:30:30.536Z","repository":{"id":43047750,"uuid":"280536589","full_name":"mrmaxguns/dream-journal","owner":"mrmaxguns","description":"A python flask-based dream journal.","archived":false,"fork":false,"pushed_at":"2023-05-01T21:44:07.000Z","size":7005,"stargazers_count":10,"open_issues_count":3,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-31T22:25:30.533Z","etag":null,"topics":["bootstrap-5","flask","flask-sqlalchemy","markdown","python","python3","waitress"],"latest_commit_sha":null,"homepage":"https://mrmaxguns.github.io/dream-journal","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrmaxguns.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-17T22:26:42.000Z","updated_at":"2024-12-23T22:36:55.000Z","dependencies_parsed_at":"2022-09-06T10:01:52.611Z","dependency_job_id":null,"html_url":"https://github.com/mrmaxguns/dream-journal","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmaxguns%2Fdream-journal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmaxguns%2Fdream-journal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmaxguns%2Fdream-journal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrmaxguns%2Fdream-journal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrmaxguns","download_url":"https://codeload.github.com/mrmaxguns/dream-journal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238386204,"owners_count":19463316,"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":["bootstrap-5","flask","flask-sqlalchemy","markdown","python","python3","waitress"],"created_at":"2024-09-27T16:04:02.991Z","updated_at":"2025-10-26T19:30:24.307Z","avatar_url":"https://github.com/mrmaxguns.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![An image showing the basic layout of the dream journal](docs/assets/img/home.gif)](https://mrmaxguns.github.io/dream-journal/)\n\u003ch1 align=center\u003eDream Journal\u003c/h1\u003e\n\n\u003cp align=center\u003eA simple, smart dream journal app built with python flask.\u003c/p\u003e\n\u003cp align=center\u003e\u003ca href=\"#installation\"\u003eInstall\u003c/a\u003e | \u003ca href=\"https://mrmaxguns.github.io/dream-journal/docs\"\u003eDocumentation\u003c/a\u003e | \u003ca href=\"https://mrmaxguns.github.io/dream-journal/contribute\"\u003eContribute\u003c/a\u003e\u003c/p\u003e\n\n## Installation\n\nMake sure you have the following prerequisites:\n1. Python \u003e= 3.6\n2. pip for your version of python\n3. git versioning system\n\nInstalling the app is easy:\n\n1. Clone the repository in the directory you wish: `git clone https://github.com/mrmaxguns/dream-journal.git`\n2. Enter the `dream-journal` directory. (`cd dream-journal`)\n3. Install requirements: `pip install -r requirements.txt`\n4. Run the app: `python3 dream-journal/run.py`. On first run, the database will be created. A new tab with the app will open.\n\n## Basic Usage\n\n### The homepage\n* The homepage lists all your recorded dreams with the most recent ones first. Click on a dream title in order to visit the dream log.\n* The homepage also lists all the functions you can do such as creating a dream, searching dreams or filtering dreams.\n\n## Creating a dream\n* Go to the homepage and click on `Create a new dream` on the top left side of the screen.\n* Fill out the form with the following information:\n  * **Title**: the title must be unique for every dream and describe its contents.\n  * **Write what happened in your dream**: in the next input, write out your dream in detail. This input also supports standard markdown headings, bold, italics, quotes, etc. The markdown will render whenever you visit the dream page.\n  * **Tags**: write tags separated by a comma that you can use to sort and categorize your dream.\n  * **Characters**: The characters in your dream separated by a comma. These can be yourself and even important objects.\n  * **Locations**: The times and places of your dream separated by a comma.\n  * **Type of dream**: The dream type describes if your dream is regular, a nightmare, lucid dream, etc.\n  * **The date of your dream**: The date you had the dream. It is up to you to determine what date the dream happened on.\n* Click the Create Dream button once you are done filling out the information.\n\n## Viewing, editing, and deleting dreams\n* The easiest way to access the dream is through the homepage. Dreams can also be accessed by searching or filtering.\n* Once you open the dream page, you will find all information relating to the dream.\n* To edit the dream, click the pencil icon. An editor will pop up. Make sure to save the edits by clicking the \"Update\" button on the bottom of the page.\n* To delete a dream, click on the trash icon. It will then ask if you are sure. Click yes to delete the dream forever.\n* To go back to the homepage, click the arrow pointing to the left side.\n\n## Searching for dreams\n* This app provides a basic keyword search feature that scans the titles and bodies of dreams and provides most relevant results.\n* The search can be accessed through the homepage by clicking on the \"Search\" link next to a magnifying glass.\n* Once at the search page, type your query. Results will show up below.\n\n## Filtering dreams\n* Filtering dreams is great for filtering tags, characters, locations and types of dreams.\n* To open the filter page, go to the homepage and click the \"Filter\" text next to the funnel.\n* Type your filter query: when typing the query, it must be exactly worded but case doesn't matter. Select the type of item you want to filter in the menu below and press \"Filter\".\n\n# License\nThis project is licensed under the MIT license, so we value open-source contributions. Please see the LICENSE file for more details.\n\n# Built with\n* [Python 3](https://python.org): programming language\n* [Flask](https://flask.palletsprojects.com): web framework\n* [Flask-SQLAlchemy](https://flask-sqlalchemy.palletsprojects.com): database\n* [Markdown2](https://github.com/trentm/python-markdown2): markdown support\n* [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/): python WSGI server\n* [Bootstrap](https://getbootstrap.com/): CSS and JS framework\n* [Black](https://black.readthedocs.io/en/stable/): Python linting\n* [Isort](https://timothycrosley.github.io/isort/): Import sorting\n\n# Creator\nMaxim R: [mrmaxguns](https://github.com/mrmaxguns)\n\n# Contribute\nContributions are welcome! To learn how to contribute, visit [our official contribution page](https://mrmaxguns.github.io/dream-journal/contribute/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrmaxguns%2Fdream-journal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrmaxguns%2Fdream-journal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrmaxguns%2Fdream-journal/lists"}