Skip to content

kangazoom/runlines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 

Repository files navigation

What is this app?

This mobile app was created during Ada Developers Academy's month-long capstone project, in which each student created a project using at least three new self-taught technologies. This app uses the Google Speech-to-Text API to help actors memorize scenes. Users record their memorized line after viewing a cue line. The app then displays the actual text from the scene as well as a transcript of the recording, with missed and extra words highlighed.

Motivation

Other mobile apps allow the actor to record and listen to their and other characters’ lines, but none tell the actor when they miss a word or flub a line.

Screenshots

Click an image below for the video version (the last two feature audio)

Adding a new scene Reciting a line (no mistakes) Reciting a line (missed and extra words)
Adding a new scene Reciting a line without any mistakes Reciting a line with both missed and extra words

Setup

Technologies

Dependencies

  • axios (API requests)
  • react (front-end library)
  • react-native (mobile library)
  • react-native-audio-player-recorder (audio recorder)
  • react-native-fetch-blob (audio file Base64 encoder)
  • react-native-firebase (cloud data store)
  • react-native-multiple-select (versatile drop-down menu library)
  • react-native-router-flux (app navigation)
  • react-native-vector-icons (extensive vector icon library)

Installation + Launch instructions

  1. Fork and clone this repository
  2. cd into the runlines/ directory
  3. Obtain a GoogleService-Info.plist file and (if needed) cocoapods functionality by adding Firebase to the project here
  4. Add Firestore to your project here
  5. Run npm install to install dependencies
  6. cd into the ios/ directory and run pod install to install cocoapod dependencies
  7. Set up a Google Speech project in the Google Cloud console, with service key here
  8. Set up a new API authentication key, with (at minimum) API restrictions limited to Google Cloud Speech API here
  9. Add a keys.json file to the runlines/ directory. Add the following text to the file, inserting your API key from the previous step where it says ENTER_YOUR_KEY:
{GCS_API_KEY: "ENTER_YOUR_KEY"}
  1. Run npm start to launch the packager
  2. Wait for the Xcode iOS Simulator to launch the app

Troubleshooting

If the build fails, try uninstalling and reinstalling dependendencies:

  1. cd into the runlines/ directory
  2. run rm -rf node_modules/ && rm package-lock.json
  3. run npm install
  4. run react-native link
  5. If any messages from the previous step mention that a library was already linked, then run react-native unlink LIBRARY_NAME and replace LIBRARY_NAME with the name of the library from the message
  6. If you ran the previous step and unlinked libraries, then re-run react-native link
  7. cd into ios/ directory and run rm -rf pods/ && rm Podfile.lock
  8. run pod install
  9. run pod repo update

TODO

  • Find future features I would love to implement here

Thank You

  • Ada Developers Academy, especially my instructors Dee and Dan
  • Brian Ledbetter, for his mobile dev mentorship

License

MIT License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published