JVP Boiler

BRIEF SUMMARY OF PROJECT (1-2 sentences)

---

Table of Contents

• JVP Boiler
  • Table of Contents
  • Our Goal
  • Developer Roadmap
  • Installation
    • Initial Setup
    • Running the Application
    • Using the Application
  • Resources
    • Technologies
      • Important Node Modules
      • Recommended VS Code Extensions
        • Markdown All in One
        • npm
        • npm Intellisense
    • Helpful Guides
  • Contributors

---

Our Goal

This is where we talk about our goal with this project This is where we talk about our goal with this project This is where we talk about our goal with this project This is where we talk about our goal with this project This is where we talk about our goal with this project This is where we talk about our goal with this project This is where we talk about our goal with this project

---

Developer Roadmap

These ideas will be pursued in the futureL

• Swagger for API documentation
• Python with node

---

Installation

This application requires Git, NodeJS at v4+ to run. If that is not on your machine, visit the relevant documentation pages to have the technologies installed.

Initial Setup

If this is the first time setting up the project, follow the steps below.

• Clone the remote repository to your local machine:
  • git clone bitbucketlinkhere.bitbucketlinkhere
• Navigate to the newly cloned direcory:
  • cd Innovate48
• Install project dependencies found in the package.json file:
  • npm install or npm i

Running the Application

After installing the dependencies, the application will be able to successfully run. There is a start script that handles this in the package.json file.

To execute the start script, run: npm run start or npm start

Using the Application

Write how to use the application here :)

---

Resources

This section contains important resources, guides, open-source libraries and other general information about the project.

Technologies

This project utilizes the following technologies:

• NodeJS - a JavaScript backend that serves as the foundation for the application and API
• ExpressJS - designed for easily building APIs around a popular framework and works seamslessly with NodeJS
• Express Validator - validates HTTP requests made to the API
• Bootstrap - a popular HTML, CSS and JavaScript library that allows for quickly developing frontend web applications
• [MongoDB] - an open-source, document database and the most popular NoSQL database that integrates with NodeJS through Mongoose
• BitBucket - a popular source control manager, or SCM, that will store the codebase and offers applications for a robust developer experience

Important Node Modules

The following [npm packages] can be considered the most important to the project:

• ExpressJS - a desc
• Mongoose - a desc

Recommended VS Code Extensions

The following extensions are not required for running, building or using the application, however, they made the development experience much easier.

Markdown All in One

• Id: yzhang.markdown-all-in-one
• Description: All you need to write Markdown (keyboard shortcuts, table of contents, auto preview and more)
• Version: 2.2.0
• Publisher: Yu Zhang
• VS Marketplace Link for Markdown All in One

npm

• Id: eg2.vscode-npm-script
• Description: npm support for VS Code
• Version: 0.3.5
• Publisher: egamma
• VS Marketplace Link for npm

npm Intellisense

• Id: christian-kohler.npm-intellisense
• Description: Visual Studio Code plugin that autocompletes npm modules in import statements
• Version: 1.3.0
• Publisher: Christian Kohler
• VS Marketplace Link for npm intellisense

Helpful Guides

The following guides or articles were found to be relevant and useful to the project:

• Some Medium article

---

Contributors

Special thanks to the following team members that made this project possible:

• John Regan
• Karsten Propper
• Brian Castello
• John Pizzitola

---