Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 3.32 KB

README.md

File metadata and controls

50 lines (42 loc) · 3.32 KB
Raw

A simple MEAN stack Quiz Application

MEAN Stack QuizApp is built with a collection of JavaScript based technologies from Client to Server to Database. This repository contains the code for a RESTful API that was built using the MEAN stack:

  • MongoDB
  • Express
  • Angular (v.4.0.1)
  • NodeJS

Prerequisites

  • NodeJS - Download and Install Node.js. You can find free NodeJS tutorials at nodeschool.io to get you started.
  • MongoDB - Download and Install MongoDB - Make sure it's running on the default port (27017).

Additional Packages

  • Express - web application framework for NodeJS.
  • Mongoose - a NodeJS library that provides MongoDB object mapping.
  • Body Parser - populates req.body with the value of the POST parameter.
  • CORS - Cross-Origin Resource Sharing. Enables requests of resources from a different domain.
  • Angular 4 - a structural JavaScript framework for dynamic web apps.
  • Angular CLI - a command line interface to scaffold and build Angular apps using NodeJS style.

Quick Install

The quickest way to get started is to clone the project and utilize it like this:

1. Install dependencies from root folder using your command line:

npm install

optionally you can install nodemon which will monitor your source code and automatically restarts your server when detects any changes. To install nodemon use:

npm install -g nodemon

2. Add Your Auth0 Credentials

open the environment.ts and environment.prod.ts files located at ng-src/src/environments/ folder, and add your Auth0 Client ID and Auth0 Domain name.

3. After installation is finished use:

node server

or use this command if you've installed nodemon:

nodemon server

4. Then open your browser and go to:

http://localhost:5000

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.