jvit1985 / huntsmen

A social media forum that allows users to login or signup and connect with other outdoorsmen. The 3rd party API also allows users to search for state parks by state.

The Huntsmen

Description

What was your motivation for creating this project? To create a forum for outdoor enthusiats to connect Why did you build this project? To allow like minded individuals a space to collaborate and also find their next adventure What problem does it solve? This solves the problem of allowing those interested in outdoor activities to connect What did you learn from this project? I learned proper MVC structure for a project as well as linking to a database for CRUD api routes

Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Questions

Installation

Here are the installation instructions for this project: Install the project by pulling from github then put in your mysql database name, username, and password in a .env file. Type npm start and the project will turn on the server. Go to localhost:3001 in your browser to view and use the site.

ScreenShot:

Deployed Application: https://huntsmen.herokuapp.com/

Usage

Here are the instructions and examples of how to use this project: You can login or signup to begin using the login page. You can view all posts on the home page, clicking on each individual post from the home page will allow the user to add comments or upvote the individual post. When the user clicks on Dashboard they are taken to the login screen if they are not logged in, or their dashboard if they are logged in. From the dashboard screen the user is able to click New Post to create a post. The user is also able to click on an individual post and can edit the title and/or content of the post or delete the post entirely. On the left side of all screens the user is able to search for all state parks by state abbreviation (ex. TX for Texas), once the user types in the state code and clicks search a list of state parks is generated and the state parks website link is also generated, which the user can click on to go to that State Parks site. There is also a made by section at the bottom with links to the github accounts for everyone who created the project.

License

Here is the link for the license and copyright details: https://choosealicense.com/licenses/mit/

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.

Contributing

Here are the contributors to this project: https://github.com/BrandonDaws

Tests

Here are the tests for this project: None

Questions

If you have any questions please check my Github at https://github.com/jvit1985 Or reach out to me by email at [email protected]