Skip to content

jessamarie/recall-api

Repository files navigation

recall-api

This is the api that goes along with the recall recall app

required software

  • NodeJS 16
  • MongoDB

Installation instructions and starting the app

First install dependencies and seed the app:

npm install
npm run seed

Next run webpack (uses hot module replacement) and start the server:

npm run watch
npm run start

Or for automatic restart of server upon changes:

npm run watch
npm run start:watch-dev

API

example: localhost:4000/api/topics

topics/     # get all topics
topics/:id  # find a topic & it's sentences by id

Future of the app

See project board

Also see Planning

unsolved problems or major hurdles

  • Slight learning curve with OvernightJS
  • Adding middleware
  • Proper handling of bad routes