Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public
src
.gitignore
README.md
````
package.json
renovate.json
yarn.lock

README.md

README

  • This app is the frontend and user interface for anki_sound_backend (https://github.com/bretfunk/anki_sound_backend). AnkiSound allows users to covert text to audio files and download them in one of 20+ languages. A user can then use these files in Space Repetition Systems (SRS) like Anki. The frontend works by itself to download audio files without accessing the backend. To save phrases to a user profile, the backend applciation is needed.
  • The frontend is written in React.js, Redux and Javascript and the backend is written in Ruby and Rails and AWS. Stying is done with bootstrap. B
  • This app uses AWS API Gateway, Lambda, and S3. The lambda code can be found here: https://github.com/bretfunk/anki_sound_lambda
  • You can see a live version of this program at: https://bretfunk.github.io/anki_sound_frontend/
  • A basic walkthrough can be found here: https://youtu.be/3ly823FDBK0

React version

Deployment instructions

  1. Clone down the repo using the command below in your terminal:
  1. Change directory into the anki_sound_frontend directory
  • $ cd anki_sound_frontend
  1. Run npm install to install dependencies
  • $ npm install
  1. To run locally, run npm start
  • $ npm start
  1. This app is currently hardcoded to work with the static heroku URI that is live. To change, change the .url.js file. You will also need to add the new address to the backend's cors.rb initialize file if using anywhere other than localhost:3000.

Accessiblity

  1. This application was built with accessiblity in mind.
  2. Contrasting colors and reliance on buttons were used to make this application accessiable.
  3. A future accessiblity feature will be the ability to listen to files without downloading them, providing the audio in a lot fewer steps.
  4. If there is a feature you would like to request, email the application creator at bret.e.funk@gmail.com

Bugs

If you notice any bugs please add a PR or email the application creator directly at bret.e.funk@gmail.com

Troubleshooting

Reread the instructions to make sure you didn't miss anything. Most of the issues revolve around CORS so troubleshoot using the inspector on your browser of choice. If you are recieving CORS issues, double check that the backend application has your frontend URI on the list of acceptable origins.

If you are having issues logging in then the user might not be in the database. Check inspector tools to ensure the request coming back from the server is acceptable.

If the file you wish to download cases the application to crash, this is a download bug that is currently being investigated. We are in the process of changing how our backend downloads files to make it more reliable.

Upcoming Features

-Once a user is created they are automatically logged-in -Users can play files from profile

To request a feature, email the application creator directly at bret.e.funk@gmail.com

You can’t perform that action at this time.