https://github.com/amacwhirter/flashcard-generator
Georgia Tech Week 11 - Flashcard Generator
https://github.com/amacwhirter/flashcard-generator
coding-bootcamp flashcard-generator georgia-tech javascript node-js
Last synced: 4 months ago
JSON representation
Georgia Tech Week 11 - Flashcard Generator
- Host: GitHub
- URL: https://github.com/amacwhirter/flashcard-generator
- Owner: amacwhirter
- Created: 2017-04-10T01:39:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-23T17:15:18.000Z (almost 8 years ago)
- Last Synced: 2025-01-08T06:43:33.293Z (5 months ago)
- Topics: coding-bootcamp, flashcard-generator, georgia-tech, javascript, node-js
- Language: JavaScript
- Homepage:
- Size: 1.48 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flashcard-Generator
Georgia Tech Week 11 - Flashcard Generator
```
This app is the backend for a basic flashcard application.
The backend will essentially constitute an API that allows users to create two types of flashcards.
Basic flashcards, which have a front ("Who was the first president of the United States?"),
and a back ("George Washington").
Cloze-Deleted flashcards, which present partial text ("... was the first president of the United States."),
and the full text when the user requests it ("George Washington was the first president of the United States.")
```
### Getting Started
```
To get started on this project, follow the installations instructions below.
```
### Installations
``` Installing
Before you contribute
Make sure you install all the dependencies you need for the project
Once you have Node.js installed on your computer
Navigate to the working directory and do the following in your terminal
Before you proceed, make sure you fork the repo
###### Step 1
> npm install
The above command will install all the dependencies you need
###### Step 2
> Enter 'node flashcards' in CLI to kickstart app
Happy Contributing!
```
### Built With
```
* Node.JS
* JavaScript
```
### Contributing
```
There are different ways to contribute
* Back End
* Designers
* Genius Idea's
* Unit Testers
* etc.
```
### Contributers
```
* Ashley MacWhirter
```