Flashy is a dynamic and user-friendly flashcard app designed to enhance learning and memory. It is an intuitive application that allows users to create, manage, and engage with diverse learning sets, offering features like marking difficult cards, and interacting with others' sets through likes and comments. It also includes advanced search and filtering, favorites saving for later review, and admin privileges for content moderation, making it ideal for any learning scenario.
This project uses Vite as the build tool and React as the frontend framework with TypeScript for type safety. The backend is built with Firebase, and the database is Firestore.
To run the project locally, you need to have Node.js and Yarn installed. If you don't have these installed, you can download them from the following links:
When you have Node.js and Yarn installed, you can follow these steps to run the project locally:
- Clone the repository
- Open the terminal and navigate to the /flashy/frontend/ directory
- Run
yarnto install the project dependencies - Run
yarn devto start the development server - Follow the instructions in the terminal to open the project in your browser
This project uses Vitest for testing. To run the tests, navigate to the frontend folder in the terminal and use the following command:
yarn test
This project is authored by Group 50.
The group members are: Noel Fissahazion, Nora Borgenvik, Jayan Thayananthan, Kaveen Garthigayan, Sara Seeberg-Rommetveit, Amalie Johansen Vik and Christian Johan Andersen.