Giter VIP home page Giter VIP logo

mahmoud-aboudeghedy / flashcardsage Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 124 KB

FlashCardSage is a web application for creating and managing flashcard decks. It allows users to create decks, add flashcards to them, and study the flashcards.

Home Page: https://flashcardsage.onrender.com/

JavaScript 35.95% HTML 1.92% CSS 14.91% TypeScript 47.22%
express mern-stack mongodb node react react-router typescript vite

flashcardsage's Introduction

FlashCardSage

FlashCardSage is a web application for creating and managing flashcard decks. It allows users to create decks, add flashcards to them, and study the flashcards.

Features

  • Create and delete flashcard decks
  • Add and delete flashcards within decks
  • Study flashcards in a deck
  • Responsive design for mobile and desktop devices

Technologies Used

  • React: A JavaScript library for building user interfaces
  • React Router: A routing library for React applications
  • Vite: A fast build tool for modern web applications
  • TypeScript: A typed superset of JavaScript
  • ESLint: A pluggable linting utility for JavaScript and JSX
  • CSS: Cascading Style Sheets for styling the application

Getting Started

To get started with FlashCardSage, follow these steps:

  1. Clone the repository: git clone <repository-url>
  2. Install the dependencies: npm install
  3. Start the development server: npm run dev
  4. Open your browser and navigate to http://localhost:3000

Folder Structure

The project structure is as follows:

  • client: Contains the client-side code
    • src: Contains the source code for the application
      • App.tsx: The main component of the application
      • Deck.tsx: Component for displaying a single flashcard deck
      • Header.tsx: Component for the application header
      • index.css: CSS styles for the application
      • index.html: HTML template for the application
      • main.tsx: Entry point of the application
    • package.json: Contains the project dependencies and scripts
    • tsconfig.json: TypeScript configuration file
  • README.md: This file

Contributing

Contributions to FlashCardSage are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you would like to contribute code, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License.

flashcardsage's People

Contributors

mahmoud-aboudeghedy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.