No description, website, or topics provided.
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.
.aws
app
bin
config
db
lib/tasks
log
public
spec
tmp
vendor
.gitignore
.gitmodules
.rspec
.ruby-version
Gemfile
Gemfile.lock
README.md
Rakefile
config.ru
~

README.md

README

This README is for the backend portion of the AnkiSound application. This backend provides API endpoints of users and phrases so that the frontend portion (https://github.com/bretfunk/anki_sound_frontend) can access the data. This data is public but is protected with the Knock authentication gem. A token verifying that a user is in the database is required in order to access the endpoints. A live version of this app can be seen here: https://anki-sound-backend.herokuapp.com/

For a walkthrough of an older version, click here: https://www.youtube.com/watch?v=3ly823FDBK0&t=6s

Endpoints:

Public:

Generic welcome message with avaiable API endpoints
  • /

Protected:

Shows the current user's information (id, email, password_digest)
  • /api/user
Shows the current user's phrases (phrase, language)
  • /api/phrases

Ruby version

  • 2.4.1

Database creation

  1. rake db:setup {rake db:create, rake db:migrate, rake db:seed}

How to run the test suite

  1. The test suite is written in Rspec and covers model tests.
  2. Because this backend is protected with authorization from the frontend program, it is impossible to test the public endpoints directly.
  3. The test suite is written using factory_bot_rails and shoulda-matchers.

Services (job queues, cache servers, search engines, etc.)

  1. There are no services in this application.
  2. This application is API only.

Deployment instructions

  1. Clone down the repo using the command below in your terminal:
  1. Change directory into the anki_sound_backend directory
  • $ cd anki_sound_backend
  1. Create the database, run the migrations, and run the seed file:
  • $ rake db:setup
  1. Start up your server:
  • $ rails s
  • Keep in mind that the front end app is built to work with the heroku app so you will need to change your front end application to access your localhost or wherever you deploy your application.

Accessiblity

  1. This application was built with accessiblity in mind.
  2. For more details, see the accessiblity portion of the frontend readme here:https://github.com/bretfunk/anki_sound_frontend/blob/master/README.md