Skip to content

olcayhan/quizlet-clone

Repository files navigation

Quizlet Clone - Readme

Website Link : https://quizlang.vercel.app/

Quizlet Clone is a web application that resembles the original Quizlet platform, allowing users to create, share, and learn digital flashcards. This document outlines the necessary steps to run, deploy, and use the Quizlet Clone project.

Features

  • Users can create digital flashcards and categorize them into sets.
  • Login and registration features enable users to store and manage their personal card sets.
  • Users can view, search, and use card sets created by other users.
  • Users can create cards with questions on the front and answers on the back.
  • An automatic evaluation system helps users track their progress in learning the cards.

Installation

To run Quizlet Clone on your local machine, follow these steps:

  1. Clone the repository to your computer or download it as a zip:
git clone https://github.com/olcayhan/quizlet-clone.git

or download the zip file from here and extract it.

  1. Navigate to the project folder:
cd quizlet-clone
  1. Install the required dependencies:
npm install

or

yarn install
  1. Start the application:
npm start

or

yarn start
  1. Open the following address in your browser:
http://localhost:3000

Usage

Quizlet Clone has a user-friendly interface and is easy to use. Follow these steps to use the application:

  1. On the homepage, click the "Log In" or "Sign Up" button to create an account or log in with an existing one.

  2. After logging in, view existing card sets in the "Card Sets" section or click the "Create New Card Set" button to create your own set.

  3. While creating the card set, enter the question and answer for each card.

  4. When you finish creating the card set, click the "Save" button to store the card set.

  5. On the homepage, you can search and use card sets created by other users. To open a card set, click on the set, and to see the cards, click the "View" button next to the set.

  6. Review the cards, with questions on the front and answers on the back, and start learning.

Contributing

If you'd like to contribute to this project, follow these steps:

  1. Fork this repository.

  2. Create a new branch:

git checkout -b feature/your-feature-name
  1. Make changes and commit:
git commit -m "Add a new feature"
  1. Push to your forked repository:
git push origin feature/your-feature-name
  1. Create a Pull Request (PR) and provide a brief explanation of your changes.

  2. We'll review your PR and merge your changes into the main project.

Contact

If you have any questions or feedback, you can reach us at [email protected].