README.md

cc-api

A bare-bones homebrew implementation of the Caribbean Cinemas API, being built in TypeScript using web scrapers. An official API exists, this is just a fun exercise. For personal use only.

Note: Since the data for this API is being obtained by scraping the web page, it is not expected to be accurate forever. In fact, new data will be unobtainable once the web page changes, at least until the scrapers get updated to compensate. In any case, this is a toy project and should be treated as such.

How To

Run the API

yarn serve

Scrape theatres and update database

yarn tasks get-movie-theatres --persist

Scrape Now Showing Movies

yarn tasks get-now-showing

Scrape Coming Soon Movies and update database

yarn tasks get-coming-soon --persist

Add all movie runs for all theatres

yarn tasks add-movie-runs --persist

To-Do

• General
  • Logging
  • Throttling
  • Versioning
  • JSONAPI Schema Serialization
  • Documentation
  • Server side caching
  • Task Scheduling using Heroku Scheduler
  • Pagination
  • 100% Test Coverage
  • A Maintainability Rating
  • TravisCI Deployment