Skip to content

An app promoting gun safety and providing a place for firearm owners to safely manage and log their firearms.

Notifications You must be signed in to change notification settings

Alexva397/gunSAFE

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Two: gunSAFE

license


Description:

This application is a repository of knowledge that gives a user general information and safety concerning firearms. It gives gun owners and future gun owners a place to save their inventory into mySAFE dashboard. In addition, it gives gun owners safety and maintenance tips for their specific gun.


Table of Contents:

  1. Description
  2. Demonstration
  3. Installation
  4. Screenshots
  5. Technologies
  6. Usage
  7. License
  8. Contributing
  9. Tests
  10. Questions

Demonstration:

Deployed website link


Installation:

To use this application, the user can fork or clone. Then run npm install. See the technologies section for the application dependencies. In addition, the user will need to connect to an active database server for full functionality. However, any users may freely use this deployed application at the above deploy application website.


Screenshots:

(Deployed Application)

Deployed Application

(User Login)

User Login

(User Inventory)

User Inventory List

(Reviewing Inventory)

Reviewing Inventory

(Adding Inventory)

Adding Inventory

(New Inventory)

New Inventory

(Catalog Search)

Catalog Search

(Gun Safety)

Safety


Technologies

- Node.js
- Handlebars.js
- MySQL2
- Sequelize
- Express-session
- Dotenv
- Bcrypt
- Countapi-js 

Usage:

This application utilizes several web and database technologies that allows a user to review gun safety articles, broswse guns on an electronic catalog, and store and retrieve a personal gun inventory. The gun inventory is entered by the user and the application will save the information for later use. The user gains all of this functionality when he/she is logged into the application. A MySQL database is used to store user informatio, the users inventory, and the gun catalog. The website has a secure authentication process to access the website for both current and new users.


License:

This project falls under the MIT License. The full documentation for this license can be found at MIT Full Documentation.

Below is an excerpt of the MIT License.
Copyright

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:

To contribute to this project, please send an email.

The contributors for this project are: - Alexander Vadeboncoeur - Philip Perkins - Bryan Gee - D. Javan Worthy


Tests:

There are some test for this application. The data/communication routes must be verified before this application can be properly deployed. In addition, there must be an operational database and it must be connected to the application to receive the full functionality.


Questions:

About

An app promoting gun safety and providing a place for firearm owners to safely manage and log their firearms.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 50.1%
  • Handlebars 49.7%
  • CSS 0.2%