macias-daniel / tent-buddy

Tent Buddy

GitHub Deployed Link

Table of Contents

• Description
• Files
• Visuals
• Usage
• Installation
• Test
• Support

Description

• Tent Buddy is a widget application that provides a streamlined interface for users to be well informed before they head out on their next adventure.

Visuals

• Demonstrations of the application

Usage

• Refer to the API terms of use for proper usage. APIs: OpenWeatherMap, National Parks API, and REI Mountain Data API

Installation

• Run npm install and make sure install all dependencies.

Test

Run npm run lint from the project root to run eslint checks on the backend and front end code. Run npm run lint from the client directory to lint the client only.

The root and client have convenience scripts define to easily apply auto-fixes with eslint. Run npm run lint:fix from the root and client to apply fixes for the entire project or client only respectively.

Travis CI

A basic configuration for Travis CI is included. Configure the GitHub repo to run checks before merging to enforce linting checks and tests.

IMPORTANT! Add the mongodb service to .travis.yml if tests using MongoDB are included in the project. Likewise, if another database is used to replace MongoDB, then .travis.yml will need to be updated accordingly. Please refer to the Travis CI Documentation for more information.

Support

• Daniel Macias-Ericson

• Charlotte Mountain

• Nathan Naylor

• Kane Cruz-Walker