vulcanhrr24/repeat.it

Repeat.it

Repeat.it is a web app that allows users to create and study flashcards online. After signing into Repeat.it, users can create flashcard decks, edit existing decks, study their decks in random order and delete any decks they no longer need. A unique feature of Repeat.it is the ability to style cards as code, allowing them to create flashcards for studying various programming language snippets.

Team

• Product Owner: James Quillin
• Scrum Master: Sheena Ramirez
• Development Team Members: Patrick Tang, Junji Otsuka, Ciarán Conners

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Log-in/Sign-in

On your first visit to Repeat.it, create a user name and password and you'll automatically be logged into the site. You'll need to be signed into Repeat.it any time that you would like to review or change decks that you've created.

Home page

Click the "Create a new deck" button or the deck creation link at the top of the page to start making flashcards. Any decks that you create will later be listed on the home page, where you can also choose to study, edit or delete existing decks. When you're finished studying, click "Log out" in the top right corner of the screen to end your session.

Create/edit deck pages

Type the front and back content of each card in the designated text areas and create a card by hitting enter or the "Add card" button. Cards can be deleted and rearranged within the decks. To style a card as code click the button on the top right corner of the card. Click "Click to save the deck" at the bottom of the page when you're done with your changes.

Study deck page

Click on the card to view the answer to the current question. Use the navigation buttons below the flashcard to choose whether to view the next card or a previous card. When you're done studying, click "Save and quit" to return to the home page.

See here for more details.

Requirements

• AngularJS 1.6.4 (included as CDN)
• Angular-route (included as CDN)
• bcrypt
• body-parser
• express
• mongoose
• mongoDB
• Bootstrap (included as CDN)
• Highlight.js (included as CDN)

Development

Installing Dependencies

From within the root directory:

npm install

Tasks

In order to open the Node server and the MongoDB server, from within the root directory:

node server.js

Contributing

See CONTRIBUTING.md for contribution guidelines and ideas to extend the app.