Skip to content

mihir2004/flashcard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

Flashcard Project

Welcome to the Flashcard Project! This web application allows users to create and study with digital flashcards. It provides an interactive platform for efficient learning, helping users manage and test their knowledge across various subjects.

Live Demo

Check out the live version of the app: Flashcard Application Flashcard Dashboard

Features

  • User Authentication: Secure login and registration system.
  • Create Flashcards: Easily add new flashcards with questions and answers.
  • Edit Flashcards: Update existing flashcards for improved learning.
  • Study Mode: Engage in an interactive study session to test your knowledge.
  • Responsive Design: The application is accessible on both desktop and mobile devices.

Technology Stack

  • Frontend: React.js, HTML, CSS
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Version Control: Git

Installation

To set up the project locally, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/mihir2004/flashcard.git
    cd flashcard
  2. Install Dependencies:

    • Frontend:
      cd frontend
      npm install
    • Backend:
      cd backend
      npm install
  3. Environment Setup:

    • Create a .env file in both frontend and backend directories with the necessary environment variables.
  4. Run the Application:

    • Frontend:
      npm start
    • Backend:
      npm run dev

Usage

  1. Register or log in to the application.
  2. Create new flashcards by entering questions and their corresponding answers.
  3. Use the study mode to review your flashcards and track your progress.
  4. Edit or delete flashcards as needed to keep your study material up-to-date.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Commit your changes and push them to your fork.
  4. Submit a pull request with a detailed explanation of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any questions or feedback, feel free to reach out via GitHub issues or directly contact the repository owner.


Thank you for checking out the Flashcard Project!