# Auditory Training App

Authors:
Capstone 2: Nicole Cruz, Ashley Enalien, Rafael Mejia Galvan, Hubert Cabrera, Enrique Portela
Product Owner: Alliete Alfano

The Auditory Training App is currently in its fourth version. It is designed for adults with
hearing loss who have received a hearing aid or cochlear implant and want to improve their hearing
via fun games and other listening activities.

---

### Project Structure

The following tree structure will be useful to visualize how the project is structured:

```
mission-audition/
┣ node_modules/
┣ public/
┃ ┣ favicon.ico
┃ ┣ index.html
┃ ┣ logo192.png
┃ ┣ logo512.png
┃ ┣ manifest.json
┃ ┗ robots.txt
┣ src/
┃ ┣ assets/
┃ ┃ ┣ icons/
┃ ┃ ┗ images/
┃ ┣ components/
┃ ┃ ┣ activities/
┃ ┃ ┣ activity/
┃ ┃ ┣ auth/
┃ ┃ ┣ backdrop/
┃ ┃ ┣ cardDB/
┃ ┃ ┣ cardsLatest/
┃ ┃ ┣ Completed/
┃ ┃ ┣ custHooks/
┃ ┃ ┣ forumComp/
┃ ┃ ┣ Game Option/
┃ ┃ ┣ Game Options/
┃ ┃ ┣ homepage-sects/
┃ ┃ ┣ lingDetection/
┃ ┃ ┣ lingDiscrimination/
┃ ┃ ┣ lingIdentification/
┃ ┃ ┣ nav/
┃ ┃ ┣ modal/
┃ ┃ ┣ Option/
┃ ┃ ┣ options/
┃ ┃ ┣ playButton/
┃ ┃ ┣ pop/
┃ ┃ ┣ progressBar/
┃ ┃ ┗ store/
┃ ┣ helpers/
┃ ┃ ┣ allActivities.js
┃ ┃ ┣ allDashboardOptions.js
┃ ┃ ┣ allBetweenOptions.js
┃ ┃ ┣ allDiscriminationGames.js
┃ ┃ ┣ allIdentificationGames.js
┃ ┃ ┗ allDetectionGames.js
┃ ┣ pages/
┃ ┃ ┣ activityPage/
┃ ┃ ┣ auth/
┃ ┃ ┣ dashboard/
┃ ┃ ┣ forum/
┃ ┃ ┣ gamePage/
┃ ┃ ┣ homePage/
┃ ┃ ┣ inBetweenPage/
┃ ┃ ┣ ling/
┃ ┃ ┣ myProfile/
┃ ┃ ┣ reportsPage/
┃ ┃ ┣ reset/
┃ ┃ ┣ supportPage/
┃ ┃ ┗ settings/
┃ ┣ App.js
┃ ┣ firebase-config.js
┃ ┣ index.css
┃ ┗ index.js
┣ .env
┣ .gitattributes
┣ .gitignore
┣ package-lock.json
┣ package.json
┗ README.md
```

Code/Auditory Training App is the directory that contains all of the code required to make app functional. If/When other directories are added, they will be used for documentation.

The Auditory Training App/src directory is where all the source code for the application lies. The main entry point of the application is through index.js, which is where the application is created, and immediately calls App.js where all other components that change the UI must be referenced.

Project Structure provides a visual imagery of how classes call each other and how the project is structured.

### Installation & Running steps

The easiest way to get started with Auditory Training App is to install install Node.js. You can do that by going to :

```
https://nodejs.org/en/.
```

This will automatically install the Node Package Manager (NPM).

It is also necessary to be able to run git commands in your terminal (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), or use the desktop app (https://desktop.github.com/).

After Node.js is installed, and you can run git commands/or the app, you will need to clone the GitHub repository to your local machine using the git clone command or do so internally within your IDE.

Using your terminal, You can now install all the necessary dependencies for the node_modules folder by navigating to the directory folder, and running :

```

npm install

npm install firebase

```

It is necessary to create a firebase-config.js file. This should be placed in the src folder. To find the firebase key that should be contained in that file, please refer to the following website: https://support.google.com/firebase/answer/7015592#web&zippy=%2Cin-this-article 

Please be advised that you will have to include an export statement including db, auth, and storage.

Note: If you get an API invalid key error, please delete your local repository, re-clone from git, and run the package installation commands again.

The app can now be started on your local machine by running:

```

npm start

```
