HiveStack

You can find the deployed project HERE.

Contributors

All Team Members are listed below, as active contributors to both the front end, and the back end of HiveStack. Feel free to contact members through the links below!

Oscar Ortiz-PM	Aciel Ochoa	Aaron Johnson	Cody Caro

Elijah Paminsan	Elizabeth Doyle	Jacqueline Omollo	Kim Kiamco

Project Overview

Trello Board

Product Canvas

HiveStack is a platform designed for avid WiFi users to be able to easily find hotspots that cater to their unique technical and environmental needs. A user will be able to search locations based on proximity to his/her geographical input, and the system will afford them a limited range of details about each location returned. They will be only able to see HiveStack locations without registering for a user account, and will also be limited to searching a limited range of environment variables.

Once a general user registers for an account, a sea of filtration options becomes available to them (a further incentive for registration). This will include the ability to filter locations by preset environmental preferences. They will also gain access to promotions, deals and coupons from preferred HiveStack Hubs (providers), as well as being granted immediate access to the WiFi password and downloading instructions per location prior to their arrival, which increases ease of use at the location. In addition to this, a user will be able to purchase special business deals from within the application.

Future Expansions:

Providers will be able to post their location within the HiveStack network of businesses, which allows them to be featured to all general users whether or not they are logged in. This will be a motivating factor for paid registration, as Providers will not be able to register without paying for listing their business, as there will be a nominal cost associated with provider registration. Providers will also be able to offer unique coupons and discounts to the HiveStack users. They will be able to track the number of registered users. They will also be able to offer unique deals and coupons or discounts to registered users, and in turn collect payments from registered users for special deals that may be offered. Within the payment portal they will have access to a record of transactions, be able to track their received payments, and forward all proceeds to their listed bank account with implementation of the Stripe API.

Key Features

• User Registration & Signup
• Google Maps Search Integration (Google Maps API)
• User Rating and Feedback System
• Saved and Recent Locations

Tech Stack

Front end built using:

React , React Hooks & Redux

• React

  • Virtual DOM improves both the experience of the user and work of the developer — Virtual DOM helps to update any user’s changes without the other parts’ interference by applying isolated components. It greatly helps to smooth the experience of all participants in real time mode.
  • Saving time while re-using React components — React deals with isolated components, that’s why you can reuse them anytime you need. System upgrades will not impact or change your system.
  • The stable code is provided by one-direction data flow — Direct work with each component requires one-direction data flow and makes the code really stable. Another thing is that only downward data binding is possible in this JavaScript framework.
  • An open-source library with a variety of tools — All updates are released to the community. React has had the open-source library and engineers can introduce the additional tools.

• Redux

  Redux favors predictability and control over your component states, making it a great choice for building consistent, cross-environment, testable applications with React. It has middleware.

• React Hooks

  • Saving time while re-using React components and creating expandable custom React Components to extend React's functionality.

Backend Modules

Dependencies

• Axios — https://github.com/axios/axios
• Redux — https://redux.js.org/introduction/getting-started
• Jsonwebtoken — https://jwt.io/
• Bcryptjs — https://www.npmjs.com/package/bcryptjs
• Helmet — https://helmetjs.github.io/
• Express — https://expressjs.com/en/guide/routing.html
• Knex — http://knexjs.org/
• Knex Cleaner — https://www.npmjs.com/package/knex-cleaner
• Dotenv — https://www.npmjs.com/package/dotenv
• Cors — https://expressjs.com/en/resources/middleware/cors.html
• PG — https://www.postgresql.org/

Dev Dependencies

• Supertest — https://www.npmjs.com/package/supertest

• Nodemon — https://nodemon.io/

• Cross-Env — https://www.npmjs.com/package/cross-env

• Jest — https://jestjs.io/docs/en/getting-started.html

• Axios — https://github.com/axios/axios

• Redux — https://redux.js.org/introduction/getting-started

• Jsonwebtoken — https://jwt.io/

• Bcryptjs — https://www.npmjs.com/package/bcryptjs

• Helmet — https://helmetjs.github.io/

• Express — https://expressjs.com/en/guide/routing.html

• Knex — http://knexjs.org/

• Knex Cleaner — https://www.npmjs.com/package/knex-cleaner

• Dotenv — https://www.npmjs.com/package/dotenv

• Cors — https://expressjs.com/en/resources/middleware/cors.html

• PG — https://www.postgresql.org/

Dev Dependencies

• Supertest — https://www.npmjs.com/package/supertest
• Nodemon — https://nodemon.io/
• Cross-Env — https://www.npmjs.com/package/cross-env
• Jest — https://jestjs.io/docs/en/getting-started.html

Back end built using:

• Node.js
• Knex.js
• PostGRES

Backend Modules

Dependencies

• Axios — https://github.com/axios/axios
• Redux — https://redux.js.org/introduction/getting-started
• Jsonwebtoken — https://jwt.io/
• Bcryptjs — https://www.npmjs.com/package/bcryptjs
• Helmet — https://helmetjs.github.io/
• Express — https://expressjs.com/en/guide/routing.html
• Knex — http://knexjs.org/
• Knex Cleaner — https://www.npmjs.com/package/knex-cleaner
• Dotenv — https://www.npmjs.com/package/dotenv
• Cors — https://expressjs.com/en/resources/middleware/cors.html
• PG — https://www.postgresql.org/

• Supertest — https://www.npmjs.com/package/supertest
• Nodemon — https://nodemon.io/
• Cross-Env — https://www.npmjs.com/package/cross-env
• Jest — https://jestjs.io/docs/en/getting-started.html

Authentication API here

Our Authentication API uses bcryptjs to hash a user's password to be stored in our PostgreSQL database. Upon a successful login, the user will recieve a jsonwebtoken that give users access to registration based features. The JWT can be accessed on on the backed by using res.locals.decodedToken on protected routes, giving you access to userId, username, and role.

Stripe API Integration

This has not been implented, and will be a future integration into this project on a possible later release canvas.

Installation Instructions

Download and Clone the Front End & Back End repositories.

Other Scripts

No additional scripts are required to run this project.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.