tullydwyer / mean-stack

Web app to manage a comic book collection

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mean-stack

Build Status Greenkeeper badge

Simple comicbook webapp built using MEAN fullstack Javascript framework + RESTful API

Requirments

  • MongoDB (3.2)
  • Node.js (Latest)
  • Bower (Latest)

How to run

  1. Install development environment requirements listed in previous section.
  2. Clone or download project.
  3. Navigate to project root folder.
  4. Install NPM packages npm install
  5. Start MongoDB process. (Run mongod.exe)
  6. Populate database by running 'populateDatabase.js' file located in root directory of project. node populateDatabase.js
  7. Start server with node.js by running 'server.js' file located in root directory of project. node server.js
  8. Access webapp with prefered browser via localhost and port 3000 http://localhost:3000/

Features

RESTful API (JSON)

The API can be accessed via HTTP. The API provides access to CRUD operations as defined in this specification.

e.g. http://localhost:3000/api/comics

  • /api/comics Retrieve all comic records
  • /api/comics/:comicId Retrieve single comic record by ID
  • /api/comics/title/:comicTitle Retrieve single comic by Title
  • /api/comics/search/:comicSearch Retrieve all comics where 'title' or 'description' contain comicSearch sting

Validation

Validation is provied both on the server via Mongoose; as well as the client side via Angular.

Single Page App (SPA)

The front end is a SPA built using Angular.

Packages used:

About

Web app to manage a comic book collection


Languages

Language:JavaScript 50.7%Language:HTML 36.2%Language:Ruby 6.3%Language:CSS 3.9%Language:PowerShell 2.9%