Skip to content
Cynthia Ma edited this page Feb 4, 2018 · 19 revisions

Frontend Routes

  • /login
  • /signup
  • /deck - welcome homepage
  • /deck/new - create a deck
  • /deck/view/:deckId - view/update a deck and view/update cards within a deck
  • /study/:deckId - study a deck
  • /search - search a deck to study
  • bonus: /users/:userId - user profile

API Endpoints

users

  • GET /api/users - returns the user information for the User Search feature
  • POST /api/users - sign up a user

session

  • POST /api/session - login a user
  • DELETE /api/session - logout a user
  • GET /api/users/recent_decks - returns the last 5 decks the user has studied
  • GET /api/users/popular_decks - returns the most popular decks the user has created

decks

  • GET /api/deck - returns index of decks (filtered by data/params)
  • GET /api/deck/:id - returns deck
  • POST /api/deck - creates a deck
  • PATCH /api/deck/:id - edit a deck
  • DELETE /api/deck/:id - remove a deck

cards

  • GET /api/decks/:deck_id/cards - returns index cards of a deck (filtered by data/params)
  • POST /api/decks/:deck_id/cards - creates a card
  • GET /api/card/:id - return a card
  • PATCH /api/card/:id - edit a card
  • DELETE /api/card/:id - delete a card

study

  • GET /api/studyscore/fetch - returns a study score of a card
  • PATCH /api/studyscore/update_by_card - updating the study score of a card

tags

  • POST /api/tag - add a tag
  • DELETE /api/tag - delete a tag

HTML

  • GET / StaticPagesController#root

Clone this wiki locally