Welcome to the README file for the Flashwise application built with Next.js!
Flashwise is a dynamic web application designed to help users learn new things efficiently and effectively. In this repository, you will find only the front-end part of the application, which was built using the Next.js framework. The back-end of the application was developed by @TBury and is not included in this repository.
The product name is Flashwise, which was chosen due to the application of the technique of spaced repetition, known as "flashcards," in the learning process. "Wise" pertains to wisdom and intuition, which the app aims to help users acquire through efficient utilization of their own flashcard sets. This name is intended to be easily memorable and to associate with the learning process using flashcards.
The application offers the following features:
- Adding flashcard sets
- Editing existing sets
- Deleting created flashcard sets
- Browsing flashcard sets by categories
- Learning mode for selected flashcard set
- User registration and login capability
- Flagging sets as private or public
- Generating quizzes and solving them
- Next.js,
- Formik & Yup
- Lottie-react
- Material-UI & Flowbite & Tailwind components
- Tailwind CSS
- Zustand
The content of this repository consists of the source files for the front-end part of the Flashwise application. To run the application locally, you need to download or clone this repository, install the dependencies, and start the development server.
You also need to set the environment variable NEXT_PUBLIC_API_URL to the URL
of the back-end server. Put it in
.env.local file in the root directory:
NEXT_PUBLIC_API_URL=http://localhost:8080
You can find the back-end documentation below: https://kacaleksandra.notion.site/The-flashwise-back-end-docs-bef70c79e8e44a3481222c9ccd38a5dd?pvs=4
Aleksandra Kacprzak (front-end) and Bartek Pacia (back-end)