https://github.com/developersunesis/udacicards

https://github.com/developersunesis/udacicards

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/developersunesis/udacicards
• Owner: developersunesis
• Created: 2020-04-25T20:20:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T03:22:10.000Z (about 2 years ago)
• Last Synced: 2023-03-07T17:55:52.645Z (almost 2 years ago)
• Language: JavaScript
• Size: 2.53 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
# Udacity Flashcard App

This is was fully built and tested for `android` platform only. This project postulates the use of React Native to create an app that store flashcard with the ability to also take quizs. The projects shows the use of React, Component, React Navigation, React States, Functional Components, React props, Redux etc.

## Installation

Clone the repository, change directories, and use NPM/Yarn to install the dependencies.

```bash

$ git clone https://github.com/developersunesis/udacicards

$ cd udacicards

$ yarn install

```

## Get Started

To get started, clone/pull the project and then:

* install all project dependencies with `yarn install`

* run app on your device or emulator with `yarn android`

## Source Files

```bash

── src

    ├── actions # Contains all the actions needed for the redux operations

        ├── index.js

        

    ├── App.js # This is the root of your app. Contains static HTML right now and the Navigator.

    ── components # all dom components and static html contents are provided in this folder

        ├── AddCard.js

        ├── AddDeck.js

        ├── BottomNavigation.js

        ├── DeckItem.js

        ├── DeckView.js

        ├── Main.js

        ├── QuestionItem.js

        ├── TakeQuiz.js

        ├── TheButton.js

    ├── reducers # contains our pure functions to update our store

        ├── index.js

    ├── utils # Contains the api calls required for the app

        ├── _DATA.js

        ├── API.js

        ├── colors.js

```

The `_DATA.js` file represents a fake database and methods that let you access the data. All datas in this file are stored in `AsyncStorage`.

## Data

There are two types of objects stored in our database:

### Deck

Questions include:

| Attribute | Type | Description |

|-----------------|------------------|-------------------|

| title                  | String | The question’s unique identifier |

| questions        | Array | The deck's flash cards |

| question | String | The question|

| answer | String | The answer|