search

CMPS-115-Webcomics / Webcomics-Backend

Nodejs based backend API for the comics viewing application
MIT License
2 stars 2 forks source link

readme

Webcomic Server

This application is a class project for CMPS 115.

The goal is to build a web application that allows webcomics to be read smoothly even on connections with latency or bandwidth issues. This repository contains the backend built in nodejs. The backend should provie a restful API for the frontend to workwith but should otherwise be decoupled (eg it does not serve html, css, images or do templating). Comic pages (the imsages) will probably be stored on a seperate service such as Amazon S3 or Google cloud storage.

This project was generated with Express Generator version 4.15.5.

Installation

  1. Clone the project using git

  2. Run npm install -g @angular/cli

  3. npm install within the project directory to get its dependencies.

  4. Place a config.json and service-account.json file into the config folder. The service-account file may be obtained from google cloud compute. The config.json file must define the keys noted in config.js. Both of these are in gitignore because they contain secrets.