almoggutin / spotower-insurance-server-node-js

SpoTower insurance assignment, server-side application that is built with Node.js and Express in javascript. Database connection with Mongoose (ODM).

SpoTower Insurance Assignment Server Node.js Javascript

This server-side application is part of the SpoTower insurance assingment built with Node.js and Javascript.

View Postman Files

Table of Contents

1. About The Application
   • Built With
2. How To Install
3. Available Scripts
4. Postman

About The Application

This server-side application is is part of the SpoTower insurance assignment.

It is built with Node.js and Express Framework with Javascript. In addition, the application's database is MongoDB with the use of an ODM like Mongoose.

In the applicaiton we can add quotes to the database, and search quotes based on a zip code.

(back to top)

Built With

• Node.js
• Express
• MongoDB
• Mongoose (ODM)
• Validator.js
• Cors

(back to top)

How To Install

Git clone

git clone https://github.com/almog-gutin/spotower-insurance-assignment-server-node-javascript.git

Instructions

• After cloning the the repository run npm i in order to install all the dependencies.
• Fill in all the values of the env variables in config/dev.env file so that the application will run properly during development mode.

(back to top)

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the production mode.
However this script is only ment to be run when deploying the application. The application is built, where you need to setup the env variables on the machine that your will be hosting it on or in a webhosting service, unlike in development mode.

npm run dev

Runs the app in the development mode.
Open localhost on the port you decided on in the env variables to view it in the browser.

The page will reload if you make edits with nodemon.

(back to top)

Postman

Above, there is a link that will take you to the postman files in my postman profile where you can test the api functionality in the browser.

However, if you would like to run the files locally on your machine in the postman desktop application, included in the repository, in the postman directory all the files so you can import them. In addition, you will have to configure env variables in postman so that you will be able to test properly everything.

(back to top)