diff --git a/README.md b/README.md
index d1eb27e..719f912 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,6 @@
-
+
- Dragonroost
-
Self-hosted Animal Rescue/Shelter Management Software, written in Python with Django and htmx.
@@ -15,7 +12,7 @@
License: MIT
-## Screenshots (current as of October 30 2024)
+## Screenshots (current as of December 2024)
@@ -23,7 +20,18 @@ License: MIT
## Roadmap
-Dragonroost is under heavy development - expect bugs and half-written features. For a general idea of what is planned, please check out the [roadmap](ROADMAP.md).
+Dragonroost is under heavy development - expect bugs and half-written features. For a general idea of what is available or planned, please check out the [roadmap](ROADMAP.md).
+
+## Getting Started
+
+Until a proper, simplified deployment is ready, you can use the following to get started testing this application:
+
+- Ensure Docker Desktop and git are installed on your system.
+- Clone the repository with `git clone https://github.com/leethobbit/dragonroost.git` and change directories to the newly created folder from the clone command.
+- Build the local dev images with `docker-compose -f docker-compose.local.yml build`
+- Start the local dev images with `docker-compose -f docker-compose.local.yml up -d`
+
+This project was built with cookiecutter-django, for more information you can view [their documentation](https://cookiecutter-django.readthedocs.io/en/latest/2-local-development/developing-locally-docker.html)
## Settings
diff --git a/ROADMAP.md b/ROADMAP.md
index c86da7f..2c2a5b6 100644
--- a/ROADMAP.md
+++ b/ROADMAP.md
@@ -2,72 +2,48 @@
The full span of functionality that Dragonroost will eventually encompass.
-## Conversion to htmx
-
-This project started out just using normal Django generic Class-based Views (CBVs) - but the constant full page reloads felt archaic, so I decided to pull in htmx (I had been wanting an excuse to learn it, anyways)
-
-- [X] **Htmx conversion**: Most of the main pages use htmx now, including the dashboard which loads all content in as partials. However, some urls for forms and other bits are not fully converted just yet.
-- [ ] **Htmx Reporting Module**: Instead of generating dashboards for each main module, an htmx-driven reporting section will be added instead. The goal is to be able to visualize (and interact with) trends over time for much of the application - animal intakes, adoptions, species trends, volunteer signups, donations over time... basically anything useful for the average small rescue.
+## Currently available
+
+Here are the things already available in Dragonroost
+
+- **Animals**, which have the following features:
+ - Physical characteristics like weight, age, color, sex, species.
+ - Other attributes, including name, description, donation fee, status, a photo, and intake date.
+ - Location of the animal in the rescue.
+- **Medical Records**, which have the following features:
+ - Each animal can have any number of medical records
+ - Records allow to tracking weights, bowel movements, notes, and treatments.
+ - The most recent record's weight will display on the Animal's page for their current weight.
+- **Species**, which have the following features:
+ - Name, description, diet, class (reptile, mammal, etc).
+- **Locations**: with a description and a name. These can be physical buildings, areas in a single building, or any other variation.
+- **Meetings**: For tracking periodic organizational meetings. Expects a link to a URL (for example,a Google Doc) but a file can be attached as well.
+- **Medical Updates**: Different from medical records, these allow medical staff to upload notes or updates from their shift.
+- **People**: Allows for tracking donors, fosters, volunteers, and vet staff and their personal information.
+
+## Upcoming/Likely features
+
+- [ ] **Animals module**:
+ - [ ] Enhanced PDF export. PDF export exists for animal records, but the output is ugly.
+ - [ ] Import from CSV.
+- [ ] **Business module**:
+ - [ ] Transactions (income/expenses).
+ - [ ] *(Possible)* A light inventory tracking system.
+- [ ] **Medical module**:
+ - [ ] *(Possible)* Tracking of treatments or medications.
+ - [ ] Vaccine calendar.
+- [ ] **People module**: Integration of People into other aspects of Dragonroost - for example, tracking who attends Meetings, which animals are with which Fosters, and more
## Ongoing work
- [ ] **Frontend styling**: I find frontend UI/UX work to be the most difficult, and so the UI is going to be constantly upgraded over time as I get more comfortable with these skills. I plan to move from Bootstrap 5 to something like Tailwind eventually, but for now, the focus is on building the core functionality.
-## Modules
-
-These are the core application modules that will be available on the 1.0.0 release.
-
-- [X] **Animals**: The core module - management of animals and their related traits and information.
-- [X] **People**: Management of volunteers, donors, fosters, and adopters.
-- [ ] **Business**: Locations (can be buildings or areas of a building), meetings, and more.
-- [ ] **Medical**: Medical staff updates, Reporting, vaccine calendar, and more.
-
-Some site-wide features that are planned for 1.0.0
-
-- [ ] **Notifications**: The scope of these is not decided yet - but will likely include intake/outcome notifs. App only.
-- [ ] **Reminders**: For vaccines, treatments, perhaps donation follow-ups, and more. Email, app, and mobile.
-- [ ] **Data Visualizations and Analytics**: Once the four core modules are roughly complete, a number of data-driven features will be added, including graphs and charts for trends related to intakes, adoptions, species that are seen, and more.
-
-## Animal Module
-
-The animal module will feature the following items:
-
-- [X] **Animal records**
-- [X] **Species records**
-- [ ] **Medical records**: These are specifically tied to individual animals.
-- [ ] **Dashboard**: With intake/outcome stats, counts for animals, and more.
-
-## Business Module
-
-The business module will feature the following items:
-
-- [X] **Location management**: Can be separate buildings, or things like "quarantine room". This is just to help keep track of which animals are where.
-- [X] **Business Meetings**: Links to external documents and associated information can be entered to help track monthly/bimonthly/quarterly staff meetings.
-- [ ] **Donation tracking**: Can optionally be linked to a person in the People module, or tracked separately. This will be expanded to include general financial transactions, income/expenses, and perhaps more.
-
-## People Module
-
-The people module will feature the following items:
-
-- [X] **People Management**: Not to be confused with Users of the application. People include volunteers, adopters, fosters, donors, partners, etc.
-
-## Medical Module
-
-The medical module will feature the following items:
-
-- [X] **Staff medical updates**: Medical staff can create updates
-- [ ] **Vaccine dashboard**: Using the information from the animals' medical records to generate the calendar.
-
-## In What Order Will This Be Done?
-
-The animal module is going to be the core of the app, and will be fleshed out first. That said, some portions of the other modules are already in place and required - for example, animals need to have a location so that is online already. The core records are first, with the dashboards coming later.
-
## Possible Future Upgrades
Here are some things not planned for the 1.0.0 release, but are ideas that could make the cut if there is interest.
- [ ] **Volunteer / Task Management**: Dashboard that features some task and volunteering scheduling information. Could use this to show a daily task list, or which volunteers are on today, etc.
-- [ ] **Finances Management**: 1.0.0 will feature a very basic donations or income tracking feature. A more comprehensive financial management section could be added to the business module. For example, tracking sales of merch, supplies - and more useful reporting.
+- [ ] **Finances Management**: Transactions (tracking expenses/income) are expected to be available in v1.0.0. Beyond that, reporting, sales, and tracking inventory are possible.
- [ ] **Multi-image and multi-doc uploads**: Not currently planned, but uploading things like x-rays and other images or docs could be added.
- [ ] **Robust permissions for Users**: The initial release will only have basic authentication, and all views will require the user to be logged in. This may be expanded in the future to allow more granular access to viewing/editing/creating records based on group or role membership (Say, vet team role vs part-time volunteer role)
-- [ ] **Widget-ized Dashboards**: What I mean by this - Dashboards that are "drag and drop" and allow you to easily customize what you see. This will be a lot of work (I think) and won't be done unless there is an interest in it, or if I find a somewhat easy way of implementing them.
+- [ ] **Widget-ized Dashboards**: What I mean by this - Dashboards that are "drag and drop" and allow you to easily customize what you see. This will be a lot of work (I think) and won't be done unless there is an interest in it, or if I find a somewhat easy way of implementing it.
diff --git a/dragonroost/static/images/favicons/dragonroost_banner.png b/dragonroost/static/images/favicons/dragonroost_banner.png
new file mode 100644
index 0000000..c279b6e
Binary files /dev/null and b/dragonroost/static/images/favicons/dragonroost_banner.png differ
diff --git a/example/screenshots/dragonroost-animal-detail.png b/example/screenshots/dragonroost-animal-detail.png
index 3536f8e..6e4e70b 100644
Binary files a/example/screenshots/dragonroost-animal-detail.png and b/example/screenshots/dragonroost-animal-detail.png differ
diff --git a/example/screenshots/dragonroost-dash-v4.png b/example/screenshots/dragonroost-dash-v4.png
new file mode 100644
index 0000000..1c5cd85
Binary files /dev/null and b/example/screenshots/dragonroost-dash-v4.png differ
diff --git a/example/screenshots/dragonroost-species-list.png b/example/screenshots/dragonroost-species-list.png
index 7e9d968..5049d28 100644
Binary files a/example/screenshots/dragonroost-species-list.png and b/example/screenshots/dragonroost-species-list.png differ