https://github.com/ianahart/meliorem
An interactive application to help the user study and learn new things
https://github.com/ianahart/meliorem
java javascript postgresql react spring-boot
Last synced: 3 months ago
JSON representation
An interactive application to help the user study and learn new things
- Host: GitHub
- URL: https://github.com/ianahart/meliorem
- Owner: ianahart
- License: mit
- Created: 2024-01-05T21:39:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:42:44.000Z (almost 2 years ago)
- Last Synced: 2025-08-20T00:30:14.791Z (11 months ago)
- Topics: java, javascript, postgresql, react, spring-boot
- Language: Java
- Homepage: https://meliorem.netlify.app/
- Size: 2.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meliorem
An application to help you study better
## Built With
- Spring Boot
- React
- PostgreSQL
## Description
Meliorem is a study/quiz application that helps the user memorize, study, and gain new skills.
It comes with a variety of features. Let me walk you through some of them. A user can create a personal account,
where they can upload an avatar and customize their preferences. You can create study sets which is essentially a group of related
flash cards. You can customize the flash cards with images, background colors, and colored text. Once you are ready to study
You can flip through the animated flash cards or if you want to do it timed, you can play through the flash cards.
If you need to export your flash cards you can do that. You can also edit and update the flash cards as you see fit. There are also public study sets
you can study, bookmarks, and you can upload your own notes from a word document and turn it into a PDF. You can track your progress with the daily/montly streak counter.
Another part of the application is creating study groups. You can invite other users/students to join your group.
The group section allows you to chat in realtime with one another and also add study sets that are related to the group.
## Table of Contents
- [Meliorem](#meliorem)
- [Built With](#built-with)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Visuals](#visuals)
- [Installation (Local)](#installation-local)
- [Usage](#usage)
- [Test Account](#test-account)
- [Credits](#credits)
- [References](#references)
- [License](#license)
- [Contributing](#contributing)
- [Badges](#badges)
- [Questions](#questions)
## Visuals
## Installation (Local)
- `git clone https://github.com/ianahart/meliorem.git`
- **cd** into the root of the cloned project
- If you have not downloaded [postgresql](https://www.postgresql.org/) go ahead and do so.
- In the terminal run `psql postgres` and create a database called `meliorem` and `\c meliorem`
- in the root of the project, run `mvn clean install`
- now cd into the folder labeled **frontend** and run `npm install`
- inside the **frontend** directory run `npm run dev`
- inside the root of the project run `mvn spring-boot:run`
## Usage
Sign up and create an account. Create your first study set and begin studying!
#### Test Account
- username: millie@gmail.com
- password: Test12345%
[Live Site](https://meliorem.netlify.app/)
[Demo](https://drive.google.com/file/d/1t514WCPX5IIyt5xwq7k65hnHkVBkT9rq/view)
## Credits
[Quizlet](https://quizlet.com/)
## References
- [Quizlet](https://quizlet.com/) Heavily inspired by Quizlet and their features.
Meliorem is purely for learning purposes to build skills and is essentially a Quizlet clone.
- [React Calendar](https://www.npmjs.com/package/react-calendar)
- [SockJs](https://github.com/sockjs/sockjs-client)
- [StompJs](https://github.com/stomp-js/stompjs)
## License
This project is covered under MIT License
Preamble
```
Copyright (c) 2024 Ian Hart
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Contributing
No contributions are being accepted at this time.
## Badges
[](https://github.com/ianahart/meliorem/main/LICENSE)
[](https://github.com/ianahart/meliorem/issues)
[](https://github.com/ianahart/meliorem/stargazers)
## Questions
- Get in touch with me through [email](mailto:ianalexhart@gmail.com).