Wondering what’s next for npm?Check out our public roadmap! »

    flashbot

    1.3.0 • Public • Published

    flashbot

    travis-ci MIT License

    The lean, mean, flashcard consuming machine

    Create flashcards quickly and easily

    Flashbot takes simple marked files (example below) and creates shuffled flashcard quizzes. Enjoy the benefits of storing flashcard files instead of requiring a dependence upon an internet connection and a web app.

    Installation

    npm install -g flashbot
    

    Usage

    Copy/Paste the following into a file named 'example.txt'

    flashbot
    ---
    A cli utility for the creation of flashcard quizzes.
    ---
    Nodejs
    ---
    A JavaScript runtime built on Chrome's V8 JavaScript engine.
    ---
    Developer
    ---
    A person or thing that develops something.
    ---
    Amazon (Amazon.com)
    ---
    Is the world's largest online retailer and a prominent cloud services provider
    ---
    Artificial Intelligence
    ---
    The theory and development of computer systems able to perform tasks that 
    normally require human intelligence.
    ---
    Industrial Revolution
    ---
    The changes in manufacturing and transportation that began with fewer things 
    being made by hand but instead made using machines in larger-scale factories.
    ---
    Existential Dread
    ---
    It is generally held to be a negative feeling arising from the experience of 
    human freedom and responsibility.
    

    Navigate to the directory containing 'example.txt' and run the following

    flb quiz example.txt
    

    Commands

    Root: flb
    
    Name:                  Description:
    quiz | q (filename)    - Start quiz on specified file.txt.
    words | w (filename)   - Used to list words.
    defs | d (filename)    - Used to list definitions.
    -v | --version         - Get version.
    

    Motivation

    After doing my normal peruse through npm space I was dissatisfied with what was available for building txt file flashcards. Now I have flashbot to keep me company while I study.

    Development and Testing

    git clone https://github.com/jackson-elfers/flashbot.git
    cd flashbot && npm install
    npm run test
    

    Issues and Recommendations

    Feel liberated to make an outburst and open an issue if a suggestion comes to mind.

    Install

    npm i flashbot

    DownloadsWeekly Downloads

    3

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    13 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar