Skip to content

turingschool-examples/flashcards-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FlashCards Starter Kit

Fork This Repo

On the top right corner of this page, click the Fork button.

Setup

Clone down the forked repo (from your GitHub). Since you don't want to name your project "flashcards-starter", you can use an optional argument when you run git clone (you replace the [...] with the terminal command arguments):

git clone [remote-address] [what you want to name the repo]

Once you have cloned the repo, change into the directory and install the library dependencies using the command:

npm install

To verify that it is setup correctly, run npm test in your terminal. You should have skipped tests in your card test file show up.

Running node index.js from the root of your project should result in the following message being displayed in your terminal:

Your project is running...

Note that you will not need to you run this file until you are running your game file in Iteration 3. Prior to that, you should strive to use TDD to drive your code. You should check the functionality of your application by running your tests via npm test.

Where to Add Your Code

Create all of your feature code files in the src directory. Use the module.exports and require syntax to share code across files.

How to View Your Code in Action

Once you are working through Iteration 3, you will want to run the node index.js command in your terminal to run the game.

When the game is functioning appropriately, you will be prompted for each question, have the opportunity to select an answer, and will be given feedback. You will be able to play through the entire deck of cards:

flash cards example gif


Test Files Organization

Similar to feature code, your test code needs to be put in a specific place for it to run successfully.

Put all of your test files in the test directory. As a convention, all test filenames should end with -test.js. For instance: card-test.js.

Running Your Tests

Run your test suite using the command:

npm test

Releases

No releases published

Packages

No packages published