Releases: hwgilbert16/scholarsome
v1.2.0
v1.2.0 Release
Been a while since the last update! This is a large one. The highlights of this release are that Scholarsome now has folders (as suggested in #104), a settings page, and LaTeX support.
There's many bug fixes too - you should experience a much smoother experience. Sets failing to open after importing (#110) and multiple simultaneous device authentications now work as intended (fe15e65).
The change list is large, but if you'd like to read them all, you can read the full breakdown here: #106
Full Changelog: v1.1.0...v1.2.0
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
v1.1.0
v1.1.0 Release
Lots of visual and functional changes in this update - no more is the blinding white background! For those of you that self-host, the patch for sets not creating is included in this update.
- 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
- The README has been updated to reference more up-to-date pictures
- The landing page (i.e. the page you see when visiting the site while logged out) has been completely remade
- The background has been changed to an off-white
We'll also be moving to a more strict semantic versioning. As this release included breaking changes, this will be v1.1.0. In the future, only updates with small changes will cause an increase in the last digit of the version (v1.1.x). Breaking changes will cause the middle digit to change (v1.x.1), and major changes that indicate an overhaul of the application will cause the first digit to change (vx.1.1).
Full Changelog: v1.0.10...v1.1.0
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
v1.0.10
v1.0.10 Release
Merry Christmas to those of you who celebrate.
This release is a little earlier than I expected - wanted to wait longer to finalize Quizlet import functionality - but I thought it was best to get this out early as it includes a band-aid fix for the issue of sets failing to create under some yet unknown circumstances.
- 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.
Full Changelog: v1.0.9...v1.0.10
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
v1.0.9
v1.0.9 Release
UX changes and bug fixes are what this release comprises of mostly.
On the UX side, besides some visual changes, the homepage's requests have been lessened to increase a page load time. Many bugs have been fixed - with quizzes, flashcards, the navbar, and others. The Dockerfile has been modified to decrease the size of the image, and an issue with the networking has been fixed.
The quiz page now waits for everything to load before showing the quiz creation prompt. You can now tab between the erm and definition text editor when modifying a card. There is now documentation for SSL-enabled installations of Scholarsome - the feature already existed, but there was no documentation for it.
Regarding upcoming features, I've pushed back spaced repetition functionality for a bit. It was taking up a lot of my time from other features that were more pressing for most users. Additionally, the code wasn't up to great standards - I'm planning to rewrite what I've done so far on it. It is still planned, but will be released at a future time.
Full Changelog: v1.0.8...v1.0.9
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
v1.0.8
v1.0.8 Release
Small QOL update. Been busy recently so I haven't had much time to work on larger features (i.e. spaced repetition), but after the new year I'll have more time on my hands.
The logger is now more streamlined for self hosted installs. Additionally, some bugs have been fixed regarding the password reset functionality, along with HTML encoding of multiple choice quiz questions.
As always, if there's any issues, don't hesitate to reach out by opening an issue or joining our discord server.
Full Changelog: v1.0.7...v1.0.8
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
v1.0.7
v1.0.7 Release
API housekeeping in this release primarily. Tedious and time-consuming, but necessary for the application. Spaced repetition is next on the agenda.
This release has been focused on modifying the API to be more legible for a public audience in a future version. Esoteric routes have been changes to ones that are more understandable, and all routes that will eventually be public facing have been documented. Response types have been changed for security purposes for some, too.
The handbook now includes an API section. In a future version, this will include instructions for obtaining an API key.
As always, if there's any issues, don't hesitate to reach out by opening an issue or joining our discord server.
Full Changelog: v1.0.6...v1.0.7
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
v1.0.6
v1.0.6 Release
Not too many flashy changes in this release, but quite a few behind the scenes.
For the visible changes, the registration process has been converted to allow user activity even if they have not verified their email. This means that after registration, users are immediately signed in and can use core functionality. The only caveat is that there will be a perpetual banner above the header that requests them to verify their email. There is also a button to resend verification emails attached to this banner.
This was motivated due to our email ratelimiting that occurred when we last posted on Hacker News. Some users encountered issues with their accounts getting locked, essentially, as their account was created, but the verification email failed to send. This new workflow mitigates that.
Avatars are now available to be set by users under the account dropdown in the top right of the header. After being set, this is shown in the header and on the profile page of users. A link to a user's profile now appears in this dropdown, as well.
There is now a image of the homepage that appears on the landing page.
--
On the backend side, the Docker image size has been significantly reduced thanks to #34
The validation of the environment file is now less strict. This should some issues that have been encountered with this new safety measure.
ApiResponseOptions is now enforced in all routes, and the enum is now used for the frontend response validation.
--
As always, if there's any issues, don't hesitate to reach out by opening an issue or joining our discord server.
Full Changelog: v1.0.5...v1.0.6
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
v1.0.5
v1.0.5 Release
Primarily QOL changes in this release. v1.0.6 will have more substantial changes.
The documentation has been renamed to the handbook, and now has help articles for some of our features. It's integrated directly now, whereas before it was ran separately from the rest of Scholarsome. Development article hasbeen updated to provide instructions on using Docker to run needed database dependencies.
The environment file is now validated before the backend starts, there is a schema for it.
Flashcards now have some much needed accessibility changes. Arrow keys can now be used to navigate, along with the spacebar and up and down arrow keys to flip the card. Edit modals automatically open when creating a new card, and you no longer need to exit the modal and click add card if you're adding multiple in succession - there are buttons with the modal to do this.
As always, if there's any issues, don't hesitate to reach out by opening an issue or joining our discord server.
Full Changelog: v1.0.4...v1.0.5
Upgrade instructions:
If you do not have the HOST field filled out in your environment file, then it must be added, as it is now required in this release. More information can be found in the installation page in the handbook.
After adding the HOST field,
Pull the new image.
docker compose pull
Restart the service.
docker compose up -d --remove-orphans
v1.0.4
v1.0.4 Release
Fixes some frontend bugs that were not caught before the release of the last version.
Full Changelog: v1.0.3...v1.0.4
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
v1.0.3
v1.0.3 Release
This is a big one. Largest change is that importing from Anki is now available. Upload your file, set your name, and you're off to the races.
Additionally, support for embedded media in cards is now supported. Images, audio, etc. With the media support, rich text editing is now the way to edit cards - you can format text with bold, italics, code blocks, etc. Took a lot of work to get media working and to accurately keep track of files.
Regarding smaller changes, header modals have been moved to separate components for readability. Docs have been updated to reflect the new environment variables. There was an issue with 404's under the /api route resolving to the site's 404, that has now been fixed to show a programmatic 404 page.
There's likely still some bugs in there due to the sheer amount of changes - please don't hesitate to create an issue if you experience any bugs in this release.
Full Changelog: v1.0.2...v1.0.3
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.
Below is the instructions for setting up Scholarsome with local storage. Local is recommended for most users, but S3 is supported for those that require it. If using S3 media storage, reference the docs here.
| Variable | Description |
|---|---|
| STORAGE_TYPE | Required. The method that Scholarsome will store media files, either local or s3. If set to local, Scholarsome will store media files locally. |
| STORAGE_LOCAL_DIR | The absolute filepath pointing to the directory where Scholarsome should store media files. |
Restart the service.
docker compose up -d --remove-orphans
If you have issues with this release, please open an issue or join the Discord server. There are many new features in this release, making bugs likely. Reporting them helps them get fixed faster.