hwgilbert16/scholarsome

📦 Upgrade Instructions

• There are no changes to the file structure or environment file in this release - no action is required on your part other than downloading the new image.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📋 Changes

• Addition of Anki and CSV exports, and CSV imports. You can now import *and* export to Quizlet, Anki, and CSV. Your data is not locked down - you're free to take it as you wish.
• Additionally, you can export your set media (images) into a .zip file
• There is now a share button on the set page that ensures users are aware that sets can be shared with other users
• Many pages in the handbook have been rewritten and now include images. The API now includes links to the handbook for routes that require more detail.
• This will continue into next update, where the developer documentation will be enhanced
• The API now enforces more stringent checks over set content to prevent XSS attacks
• Exports and import endpoints have been moved to a separate controller
• There is now a separate endpoint to get the avatar of the authenticated user
• + 3 more

📦 Upgrade Instructions

• There are no changes to the file structure or environment file in this release - no action is required on your part other than downloading the new image.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📋 Changes

• When creating a new set, progress is now saved. Leaving the page, closing the browser, or even restarting the device will not remove the data. You can now safely leave the set creation page while working on a new set. You'll be prompted whether you want to restore your progress each time you return to the page.
• This is the band-aid fix to #72. If a set fails to create, an error message is now shown, and the card data is not deleted. You'll be able to try to create the set again.
• Sets are now able to be exported as Anki apkg files - this buttons resides next to the "edit" button on the set page, but anyone can export a set.
• Next release, you'll be able to export as a .txt formatted for a Quizlet format, and a .csv export. Additionally, .csv importing will be available next release.
• Loading spinner icons are now present on the set creation page to show when the server is in the process of creating a set.
• The profile page now displays properly on portrait-mode mobile devices.
• API auth endpoints now have correct ratelimits.
• The Dockerfile has been simplified by removing extraneous lines that were only needed for development testing.

📦 Upgrade Instructions

• There are no changes to the file structure or environment file in this release - no action is required on your part other than downloading the new image.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 Upgrade Instructions

• There is a new `compose.yml` file for this release. If you are running a Docker compose installation, make sure that you run git pull to get the new file.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 Upgrade Instructions

• There are no changes to the file structure or environment file in this release - no action is required on your part other than downloading the new image.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 Upgrade Instructions

• There are no changes to the file structure or environment file in this release - no action is required on your part other than downloading the new image.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 Upgrade Instructions

• There are no changes to the file structure or environment file in this release - no action is required on your part other than downloading the new image.
• Pull changes.
• `git pull`
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 **Upgrade instructions:**

• After adding the `HOST` field,
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 **Upgrade instructions:**

• If you're still running v1.0.2, follow the instructions from the previous release: https://github.com/hwgilbert16/scholarsome/releases/tag/v1.0.3
• Otherwise:
• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📦 **Upgrade instructions:**

• This version contains new environment variables. Please read carefully.
• Shut down the service.
• `docker compose down`
• Pull the new image.
• `docker compose pull`
• Edit your environment file. Reference the table below to understand what needs to be added.
• This version adds support for media files - these variables provide information to Scholarsome as to where the files should be stored.
• | Variable | Description |
• + 5 more

📋 Changes

• Improve flashcards and quizzes UI -> new flip animation, configuration before starting flashcards, improved mobile usability, separation of buttons from flashcards element
• Add progressive mode to flashcards -> repeats with showing cards until all cards are marked as known. Nowhere near as useful as an SRS, but a good option in the interim.
• Update readme to match new version

📦 **Upgrade instructions:**

• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📋 Changes

• New documentation site
• Reworked README
• Add header notification for selfhosted installs when update is available
• Add version number to header
• Move to AGPL V3 license

📦 **Upgrade instructions:**

• Pull the new image.
• `docker compose pull`
• Restart the service.
• `docker compose up -d --remove-orphans`

📋 Changes

• User authentication
• Complete study set implementation
• Visibility settings for sets
• Initial flashcard implementation
• Quizzes functional
• User profiles accessible
• Plans for features in future releases