bugzis / scholarsome Goto Github PK

Scholarsome (pronounced ˈskälərs(ə)m/) is a web-based and open source studying system. Through the use of flashcards, among other core features, users can practice memorization of terms and definitions, along with keeping their data secure locally.

While other services have begun to paywall core functionalities, Scholarsome intends to offer an equal alternative that does not compromise on feature sets.

Implemented features include:

• Create your own study sets ✅
• Import sets from Anki and Quizlet ✅
• Study flashcards in multiple learning modes ✅
• Create quizzes using fill-in-the-blank, true/false, and multiple choice questions ✅
• Edit your sets ✅
• Change set visibility ✅

• Interactive study games
• Spaced repetition system implementation
• Persistence of quiz results
• Editing permission sharing with other users
• Improved profile page
• User-accessible API

Scholarsome is accessible at https://scholarsome.com for individuals who are not interested in hosting it themselves. It is free and runs the same as the most recently released version.

However, the service can be hosted yourself on any system. For those wishing to self-host Scholarsome, documentation for installation can be found here.

For development purposes, Scholarsome is required to be installed outside the standard container-based system that is used for production installs. Documentation for development can be found here.

While we use many technologies, some of our most prominent are:

• NestJS
• Angular
• Prisma
• Nx

Scholarsome is an open source project. We believe in a transparent development process and are appreciative of any contributions to the project. Whether it's proposing new features, helping us fix bugs, or improving the documentation - we would love to have your help. Please refer to our code of conduct to ensure you follow the project's rules.

• Bug reports. If you run into an issue using Scholarsome, please create a bug report. Make sure you attach the bug label to your issue.
• Feature requests. We'd love to hear your ideas for future features. Please create an issue and attach the feature request label to propose a new feature.

For formal inquiries, you can contact us via [email protected]

Otherwise, we recommend joining our Discord server. Support can be asked here, along with keeping up-to-date with future versions and upcoming features.