Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adilrasheed139/aiflashcard
https://github.com/adilrasheed139/aiflashcard
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adilrasheed139/aiflashcard
- Owner: adilrasheed139
- License: mit
- Created: 2024-08-16T14:02:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-19T05:35:47.000Z (3 months ago)
- Last Synced: 2024-08-19T16:25:00.433Z (3 months ago)
- Language: JavaScript
- Homepage: https://aiflashcard-rho.vercel.app
- Size: 1.69 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome To `THINKFLASH`
**FlashCard application powered by AI**
*An Intuitive application designed to flex your brain muscles on any subject matter of your choosing*
## INTRODUCTION
Are you studying from an important exam? Perhaps you have an interview and want to test your knowledge of the expected questions from a potential employerer? Or maybe you have a healthy thirst to consume knowledge and are simply looking for an enviroment to test yourself. One of the best options to do that is with a deck of flashcards . You know the type questions on one side and answers on the flip side. This is a technique for studying that has been employed for generations upon generations but the problem is when you write those cards you already kinda know the answers and the other is you ACTUALLY have to write those cards. What if there was a way to quickly and intuitively create a deck of cards in perhaps a couple of minutes? Well now there is.....
Unleash the power of `AI` with our innovative web application designed to revolutionize the way you study and absorb information. Whether you're a student tackling challenging subjects or a professional seeking continuous growth, thinkFlash provides a seamless and interactive flashcard experience tailored to your needs. Dive into personalized learning journeys as our `AI` algorithm adapts to your progress, ensuring each session is optimized for maximum retention. Embrace the future of education and elevate your knowledge acquisition with thinkFlash – where intelligence meets intuition in the world of digital learning. Welcome to `ThinkFlash`, your dynamic gateway to effortless learning and mastery!
## Table of Contents
- [Navigation](#navigation)
- [License](#license)
- [Questions? Contact Us](#questions-contact-us)
- [Screen Shots](#screen-shots)
- [Deployment](#deployment)
## Navigation
- When a user loads the application on their device, they are greeted with a landing page naming the site, with a simple catch phrase, and a nav bar home to a `dashboard` button, along with a `login`, `signup` and an `about` button.
#
- Once an existing user logs in or a new user signs up, they are redirected to the `dashboard` page that can potentially house prior flashcard deck builds, also the navbar remains with a `login` and `signup` button and a `create new` button in the body of the page towards the top right-hand side.
#
- Should one choose to `create new`, they will be presented with a series of questions pertaining to the subject matter and size of the flashcard deck I wish to build
*If I follow those steps through a build I will be able to toggle through the newly created deck and if I wish to `save` the deck, or `edit` the deck, I will have access to such features. That is as far as an not-logged in individual may proceed.*
*Furthermore they will have the option to edit their decks by selecting individual flashcards they wish to alter or delete.*
#
- Once a user wishes to use their deck either directly from the create deck feature or by choosing from a saved deck on their dashboard a pop out window will show the deck as well as some options for interacting.
- There, a user can click on a card to flip it to the opposing side presenting the answer to the question, click a "next" arrow to move on to another card, or choose to abort the deck and head back to the dashboard.
## Screen Shots
## License
MIT License
Copyright (c) 2024 ThinkFlash
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.
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
## Questions? Contact Us
**Links to the the developers portfolios and conact information can be found here**
## Deployment
**LIVE URL:** https://aiflashcard-rho.vercel.app/