jessamarie/recall-api

api for Recall app

recall-api

This is the api that goes along with the recall app

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 webpack
npm run start

Or for automatic restart of server upon changes:

npm run webpack
npm run dev

API

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

recall-api's Issues

Convert Project to Typescript

• Convert server to Typescript
• This includes all javascript files mentioned below and anything not otherwise mentioned here:
  • Routes
  • Seeds (type-safe seeding)
  • environment configuration files
  • database configuration files
  • models/schemas
  • update readme

Add a testing framework

• Choose a popular testing framework appropriate for the project, such as Jest, and integrate it into the project.
• Create tests for any existing functionality

Add Travis CI w/ deployment options

• Create .travis.yml
  • add heroku key to secrets
  • configure deployment options to heroku

Bootstrap project for upgrades

• Update dependencies
• Add webpack
• Add Typescript
• Add a linter